swagger-generator
Generate complete OpenAPI 3.0/Swagger specification documents from endpoint descriptions. Supports RESTful API documentation with path definitions, request/response schemas, authentication schemes (Bearer JWT, API Key, OAuth2), error responses, pagination, filtering, and example values. Outputs valid YAML or JSON specs that can be rendered by Swagger UI, Redoc, or imported into Postman. Includes model generation, tag grouping, and server configuration.
Commands
| Command | Description |
|---|
| INLINECODE0 | Generate a complete OpenAPI spec from API description |
| INLINECODE1 |
Generate a single endpoint definition |
|
model | Generate a schema/model definition |
|
crud | Generate CRUD endpoints for a resource |
|
auth | Generate authentication scheme definitions |
|
error | Generate standardized error response schemas |
|
server | Generate server configuration (dev/staging/prod) |
|
tag | Generate tag definitions for API grouping |
|
merge | Merge multiple endpoint definitions into one spec |
Usage
CODEBLOCK0
Examples
E-commerce API
CODEBLOCK1
Blog API
CODEBLOCK2
Microservice API
CODEBLOCK3
Features
- - OpenAPI 3.0 — Generates valid OpenAPI 3.0.3 specifications
- CRUD generation — Complete REST endpoints for any resource
- Authentication — Bearer JWT, API Key, OAuth2 schemes
- Models — JSON Schema-based model definitions
- Error handling — Standardized error response patterns
- Pagination — Cursor and offset pagination parameters
- Examples — Request/response example values
- Tags — Logical API endpoint grouping
Keywords
swagger, openapi, api documentation, rest api, api spec, api design, documentation, endpoints, schema, backend
💬 Feedback & Feature Requests: https://bytesagain.com/feedback
Powered by BytesAgain | bytesagain.com
swagger-generator
根据端点描述生成完整的 OpenAPI 3.0/Swagger 规范文档。支持包含路径定义、请求/响应模式、认证方案（Bearer JWT、API Key、OAuth2）、错误响应、分页、过滤和示例值的 RESTful API 文档。输出有效的 YAML 或 JSON 规范，可被 Swagger UI、Redoc 渲染，或导入 Postman。包含模型生成、标签分组和服务器配置。
命令
| 命令 | 描述 |
|---|
| spec | 根据 API 描述生成完整的 OpenAPI 规范 |
| endpoint |
生成单个端点定义 |
| model | 生成模式/模型定义 |
| crud | 为资源生成 CRUD 端点 |
| auth | 生成认证方案定义 |
| error | 生成标准化的错误响应模式 |
| server | 生成服务器配置（开发/预发布/生产） |
| tag | 生成 API 分组的标签定义 |
| merge | 将多个端点定义合并为一个规范 |
用法
生成完整的 API 规范
swagger-generator spec --title 我的 API --version 1.0.0 --description 我的应用的 REST API
为资源生成 CRUD 端点
swagger-generator crud --resource User --fields id:integer,name:string,email:string
生成单个端点
swagger-generator endpoint --method POST --path /users --body name:string,email:string --response User
生成模型/模式
swagger-generator model --name Product --fields id:integer,name:string,price:number,category:string
添加认证
swagger-generator auth --scheme bearer --format jwt
生成错误响应
swagger-generator error --codes 400,401,403,404,422,500
服务器配置
swagger-generator server --envs dev,staging,production --base-url api.example.com
示例
电商 API
swagger-generator spec --title 电商 API --resources products,orders,users,categories
博客 API
swagger-generator crud --resource Post --fields id:integer,title:string,body:string,author_id:integer,status:string
微服务 API
swagger-generator spec --title 支付服务 --auth bearer --resources payments,refunds,webhooks
特性
- - OpenAPI 3.0 — 生成有效的 OpenAPI 3.0.3 规范
- CRUD 生成 — 任何资源的完整 REST 端点
- 认证 — Bearer JWT、API Key、OAuth2 方案
- 模型 — 基于 JSON Schema 的模型定义
- 错误处理 — 标准化的错误响应模式
- 分页 — 游标和偏移分页参数
- 示例 — 请求/响应示例值
- 标签 — 逻辑 API 端点分组
关键词
swagger, openapi, api 文档, rest api, api 规范, api 设计, 文档, 端点, 模式, 后端
💬 反馈与功能请求：https://bytesagain.com/feedback
由 BytesAgain 提供技术支持 | bytesagain.com
