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

Commit

Permalink
Update documents
Browse files Browse the repository at this point in the history
  • Loading branch information
@hahwul
hahwul committed Jan 17, 2024
1 parent a772f41 commit c33f316
Show file tree
Hide file tree
Showing 2 changed files with 50 additions and 28 deletions.
57 changes: 37 additions & 20 deletions docs/getting_started/support.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,35 +8,52 @@ nav_order: 4

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

## Supports
## Available Support Scope
### Endpoint's Entities
- Path
- Method
- Param
- Header
- Cookie
- Protocol (e.g ws)
- Details (e.g The origin of the endpoint)

### Languages and Frameworks

| Language | Framework | URL | Method | Param | Header | WS |
|----------|-----------------|-----|--------|-------|--------|----|
| Crystal | Kemal | ✅ | ✅ | ✅ | ✅ | ✅ |
| Go | Echo | ✅ | ✅ | ✅ | ✅ | X |
| Go | Gin | ✅ | ✅ | ✅ | ✅ | X |
| Python | Django | ✅ | ✅ | ✅ | ✅ | X |
| Python | Flask | ✅ | ✅ | ✅ | ✅ | X |
| Python | FastAPI | ✅ | ✅ | ✅ | ✅ | ✅ |
| Ruby | Rails | ✅ | ✅ | ✅ | ✅ | X |
| Ruby | Sinatra | ✅ | ✅ | ✅ | ✅ | X |
| Php | | ✅ | ✅ | ✅ | ✅ | X |
| Java | Jsp | ✅ | ✅ | ✅ | X | X |
| Java | Armeria | ✅ | ✅ | X | X | X |
| Java | Spring | ✅ | ✅ | X | X | X |
| Kotlin | Spring | ✅ | ✅ | X | X | X |
| JS | Express | ✅ | ✅ | X | X | X |
| Rust | Axum | ✅ | ✅ | X | X | X |
| C# | ASP.NET MVC | ✅ | X | X | X | X |
| JS | Next | X | X | X | X | X |
| Language | Framework | URL | Method | Param | Header | Cookie | WS |
|----------|-------------|-----|--------|-------|--------|--------|----|
| Crystal | Kemal | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Crystal | Lucky | ✅ | ✅ | ✅ | ✅ | ✅ | X |
| Go | Echo | ✅ | ✅ | ✅ | ✅ | ✅ | X |
| Go | Gin | ✅ | ✅ | ✅ | ✅ | ✅ | X |
| Go | Fiber | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Python | Django | ✅ | ✅ | ✅ | ✅ | ✅ | X |
| Python | Flask | ✅ | ✅ | ✅ | ✅ | ✅ | X |
| Python | FastAPI | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Ruby | Rails | ✅ | ✅ | ✅ | ✅ | ✅ | X |
| Ruby | Sinatra | ✅ | ✅ | ✅ | ✅ | ✅ | X |
| Ruby | Hanami | ✅ | ✅ | X | X | X | X |
| Php | | ✅ | ✅ | ✅ | ✅ | X | X |
| Java | Jsp | ✅ | ✅ | ✅ | X | X | X |
| Java | Armeria | ✅ | ✅ | X | X | X | X |
| Java | Spring | ✅ | ✅ | X | X | X | X |
| Kotlin | Spring | ✅ | ✅ | X | X | X | X |
| JS | Express | ✅ | ✅ | ✅ | ✅ | ✅ | X |
| Rust | Axum | ✅ | ✅ | X | X | X | X |
| Elixir | Phoenix | ✅ | ✅ | X | X | X | ✅ |
| C# | ASP.NET MVC | ✅ | X | X | X | X | X |
| JS | Next | X | X | X | X | X | X |


### Specification

| Specification | Format | URL | Method | Param | Header | WS |
|------------------------|---------|-----|--------|-------|--------|----|
| OAS 2.0 (Swagger 2.0) | JSON | ✅ | ✅ | ✅ | ✅ | X |
| OAS 2.0 (Swagger 2.0) | YAML | ✅ | ✅ | ✅ | ✅ | X |
| OAS 3.0 | JSON | ✅ | ✅ | ✅ | ✅ | X |
| OAS 3.0 | YAML | ✅ | ✅ | ✅ | ✅ | X |
| RAML | YAML | ✅ | ✅ | ✅ | ✅ | X |


### Specification
Expand Down
21 changes: 13 additions & 8 deletions docs/getting_started/usage.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,29 +19,34 @@ Usage: noir <flags>
Basic:
-b PATH, --base-path ./app (Required) Set base path
-u URL, --url http://.. Set base url for endpoints
-s SCOPE, --scope url,param Set scope for detection

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

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

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

Config:
--concurrency 100 Set concurrency

Others:
-d, --debug Show debug messages
-v, --version Show version
Expand Down

0 comments on commit c33f316

Please sign in to comment.