Skip to content
This repository was archived by the owner on Jul 6, 2024. It is now read-only.

Commit c33f316

Browse files
hahwulhahwul
committed
Update documents
1 parent a772f41 commit c33f316

File tree

2 files changed

+50
-28
lines changed

2 files changed

+50
-28
lines changed

Diff for: ‎docs/getting_started/support.md

+37-20
Original file line numberDiff line numberDiff line change
@@ -8,35 +8,52 @@ nav_order: 4
88

99
Noir supports various programming languages and frameworks. You can check the provided list with the command `noir --list-techs`.
1010

11-
## Supports
11+
## Available Support Scope
1212
### Endpoint's Entities
1313
- Path
1414
- Method
1515
- Param
1616
- Header
17+
- Cookie
1718
- Protocol (e.g ws)
19+
- Details (e.g The origin of the endpoint)
1820

1921
### Languages and Frameworks
2022

21-
| Language | Framework | URL | Method | Param | Header | WS |
22-
|----------|-----------------|-----|--------|-------|--------|----|
23-
| Crystal | Kemal | ✅ | ✅ | ✅ | ✅ | ✅ |
24-
| Go | Echo | ✅ | ✅ | ✅ | ✅ | X |
25-
| Go | Gin | ✅ | ✅ | ✅ | ✅ | X |
26-
| Python | Django | ✅ | ✅ | ✅ | ✅ | X |
27-
| Python | Flask | ✅ | ✅ | ✅ | ✅ | X |
28-
| Python | FastAPI | ✅ | ✅ | ✅ | ✅ | ✅ |
29-
| Ruby | Rails | ✅ | ✅ | ✅ | ✅ | X |
30-
| Ruby | Sinatra | ✅ | ✅ | ✅ | ✅ | X |
31-
| Php | | ✅ | ✅ | ✅ | ✅ | X |
32-
| Java | Jsp | ✅ | ✅ | ✅ | X | X |
33-
| Java | Armeria | ✅ | ✅ | X | X | X |
34-
| Java | Spring | ✅ | ✅ | X | X | X |
35-
| Kotlin | Spring | ✅ | ✅ | X | X | X |
36-
| JS | Express | ✅ | ✅ | X | X | X |
37-
| Rust | Axum | ✅ | ✅ | X | X | X |
38-
| C# | ASP.NET MVC | ✅ | X | X | X | X |
39-
| JS | Next | X | X | X | X | X |
23+
| Language | Framework | URL | Method | Param | Header | Cookie | WS |
24+
|----------|-------------|-----|--------|-------|--------|--------|----|
25+
| Crystal | Kemal | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
26+
| Crystal | Lucky | ✅ | ✅ | ✅ | ✅ | ✅ | X |
27+
| Go | Echo | ✅ | ✅ | ✅ | ✅ | ✅ | X |
28+
| Go | Gin | ✅ | ✅ | ✅ | ✅ | ✅ | X |
29+
| Go | Fiber | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
30+
| Python | Django | ✅ | ✅ | ✅ | ✅ | ✅ | X |
31+
| Python | Flask | ✅ | ✅ | ✅ | ✅ | ✅ | X |
32+
| Python | FastAPI | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
33+
| Ruby | Rails | ✅ | ✅ | ✅ | ✅ | ✅ | X |
34+
| Ruby | Sinatra | ✅ | ✅ | ✅ | ✅ | ✅ | X |
35+
| Ruby | Hanami | ✅ | ✅ | X | X | X | X |
36+
| Php | | ✅ | ✅ | ✅ | ✅ | X | X |
37+
| Java | Jsp | ✅ | ✅ | ✅ | X | X | X |
38+
| Java | Armeria | ✅ | ✅ | X | X | X | X |
39+
| Java | Spring | ✅ | ✅ | X | X | X | X |
40+
| Kotlin | Spring | ✅ | ✅ | X | X | X | X |
41+
| JS | Express | ✅ | ✅ | ✅ | ✅ | ✅ | X |
42+
| Rust | Axum | ✅ | ✅ | X | X | X | X |
43+
| Elixir | Phoenix | ✅ | ✅ | X | X | X | ✅ |
44+
| C# | ASP.NET MVC | ✅ | X | X | X | X | X |
45+
| JS | Next | X | X | X | X | X | X |
46+
47+
48+
### Specification
49+
50+
| Specification | Format | URL | Method | Param | Header | WS |
51+
|------------------------|---------|-----|--------|-------|--------|----|
52+
| OAS 2.0 (Swagger 2.0) | JSON | ✅ | ✅ | ✅ | ✅ | X |
53+
| OAS 2.0 (Swagger 2.0) | YAML | ✅ | ✅ | ✅ | ✅ | X |
54+
| OAS 3.0 | JSON | ✅ | ✅ | ✅ | ✅ | X |
55+
| OAS 3.0 | YAML | ✅ | ✅ | ✅ | ✅ | X |
56+
| RAML | YAML | ✅ | ✅ | ✅ | ✅ | X |
4057

4158

4259
### Specification

Diff for: ‎docs/getting_started/usage.md

+13-8
Original file line numberDiff line numberDiff line change
@@ -19,29 +19,34 @@ Usage: noir <flags>
1919
Basic:
2020
-b PATH, --base-path ./app (Required) Set base path
2121
-u URL, --url http://.. Set base url for endpoints
22-
-s SCOPE, --scope url,param Set scope for detection
2322

2423
Output:
2524
-f FORMAT, --format json Set output format
26-
[plain/json/yaml/markdown-table/curl/httpie/oas2/oas3]
25+
* plain yaml json jsonl markdown-table
26+
* curl httpie oas2 oas3
27+
* only-url only-param only-header only-cookie
2728
-o PATH, --output out.txt Write result to file
2829
--set-pvalue VALUE Specifies the value of the identified parameter
30+
--include-path Include file path in the plain result
2931
--no-color Disable color output
3032
--no-log Displaying only the results
3133

3234
Deliver:
33-
--send-req Send the results to the web request
34-
--send-proxy http://proxy.. Send the results to the web request via http proxy
35-
--send-es http://es.. Send the results to elasticsearch
36-
--with-headers X-Header:Value Add Custom Headers to be Used in Deliver
37-
--use-matchers string Delivers URLs that match a specific condition
38-
--use-filters string Excludes URLs that match a specific condition
35+
--send-req Send results to a web request
36+
--send-proxy http://proxy.. Send results to a web request via an HTTP proxy
37+
--send-es http://es.. Send results to Elasticsearch
38+
--with-headers X-Header:Value Add custom headers to be included in the delivery
39+
--use-matchers string Send URLs that match specific conditions to the Deliver
40+
--use-filters string Exclude URLs that match specified conditions and send the rest to Deliver
3941

4042
Technologies:
4143
-t TECHS, --techs rails,php Specify the technologies to use
4244
--exclude-techs rails,php Specify the technologies to be excluded
4345
--list-techs Show all technologies
4446

47+
Config:
48+
--concurrency 100 Set concurrency
49+
4550
Others:
4651
-d, --debug Show debug messages
4752
-v, --version Show version

0 commit comments

Comments
 (0)