yunabraska/Api Doc Crafter
Clean, Merge, Group, Remove and generate OpenAPI documentation.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| swagger_js | [PATH] (local=no external resource) Path to the Swagger JS file. | no | — |
| swagger_bundle_js | [PATH] (local=no external resource) Path to the Swagger JS file. | no | — |
| swagger_logo_link | [PATH] (local=no external resource) Path to URL like `index.html` | no | — |
| swagger_css | [PATH] (local=no external resource) Path to the Swagger CSS file. | no | — |
| swagger_favicon | [PATH] (local=no external resource) Path to the Swagger favicon png file. | no | — |
| swagger_logo | [PATH] (local=no external resource) Path to the Swagger logo file. | no | — |
| swagger_nav | [BOOL] Generate navigation | no | — |
| swagger_links | [BOOL] Generate download source links | no | — |
| swagger_title | [String] page title | no | — |
| encoding | [String] Encoding of the input files. | no | utf-8 |
| work_dir | [PATH] Working directory for the input files. | yes | . |
| output_dir | [PATH] Directory to save the output files. | no | ./swagger_output |
| file_download | [Path] Download external files. Separated by or `||`. (`https://petstore.swagger.io/v2/swagger.json`) | no | — |
| file_download_header | [Map] Download request header separated by or `||` and `->` (`Auth->token||x-trace-id->2008`) | — | — |
| file_includes | [GLOB] File patterns to include. GLOB patterns separated by '::' or '|'. | no | — |
| file_excludes | [GLOB] File patterns to exclude. GLOB patterns separated by '::' or '|'. | no | — |
| max_deep | [INT] Maximum directory depth to search. | no | 100 |
| enable_object_mapper | [BOOL] Enable Objectmapper additional to the OpenApiParser for more compatibility - can fail due reflection usage. | no | 100 |
| sort_extensions | [BOOL] Sort OpenAPI extensions alphabetically. | no | — |
| sort_servers | [BOOL] Sort OpenAPI servers alphabetically. | no | — |
| sort_security | [BOOL] Sort OpenAPI security schemes alphabetically. | no | — |
| sort_tags | [BOOL] Sort OpenAPI tags alphabetically. | no | — |
| sort_paths | [BOOL] Sort OpenAPI paths alphabetically. | no | — |
| sort_schemas | [BOOL] Sort OpenAPI schemas alphabetically. | no | — |
| sort_parameters | [BOOL] Sort OpenAPI parameters alphabetically. | no | — |
| sort_responses | [BOOL] Sort OpenAPI responses alphabetically. | no | — |
| sort_examples | [BOOL] Sort OpenAPI examples alphabetically. | no | — |
| sort_webhooks | [BOOL] Sort OpenAPI webhooks alphabetically. | no | — |
| sort_headers | [BOOL] Sort OpenAPI headers alphabetically. | no | — |
| sort_scopes | [BOOL] Sort OpenAPI scopes alphabetically. | no | — |
| sort_requests | [BOOL] Sort OpenAPI requests alphabetically. | no | — |
| sort_content | [BOOL] Sort OpenAPI content alphabetically. | no | — |
| sort_encoding | [BOOL] Sort OpenAPI encodings alphabetically. | no | — |
| remove_patterns | [GLOB] Keys or fields to remove from OpenAPI files. Separate servers with '::' or '|'. | no | — |
| group_tags | [GLOB] Group OpenAPI files by tags. Separate tags with '::', '|', or ','. | no | — |
| group_servers | [GLOB] Group OpenAPI files by servers. Separate servers with '::' or '|'. | no | — |
| enable_custom_info | [BOOL] Enables enrichment of the OpenAPI metadata (info, servers, tags, etc.) | no | — |
| info_title | [STRING] Sets the OpenAPI `info.title` field | no | — |
| info_version | [STRING] Sets the OpenAPI `info.version` field | no | — |
| info_summary | [STRING] Sets the OpenAPI `info.summary` field | no | — |
| info_description | [STRING] Sets the OpenAPI `info.description` field | no | — |
| info_termsofservice | [STRING] Sets the OpenAPI `info.termsOfService` field | no | — |
| info_contact_name | [STRING] Sets the OpenAPI contact name | no | — |
| info_contact_url | [STRING] Sets the OpenAPI contact URL | no | — |
| info_contact_email | [STRING] Sets the OpenAPI contact email | no | — |
| info_license_name | [STRING] Sets the OpenAPI license name | no | — |
| info_license_url | [STRING] Sets the OpenAPI license URL | no | — |
| info_license_identifier | [STRING] Sets the OpenAPI license SPDX identifier | no | — |
| externaldocs_url | [STRING] Sets the external documentation URL | no | — |
| externaldocs_description | [STRING] Sets the external documentation description | no | — |
| servers | [LIST] Comma or semicolon separated. Format: URL::Description | no | — |
| tags | [LIST] Comma or semicolon separated. Format: Name::Description | no | — |
Outputs
no outputs