OpenAPI规范生成器

生成OpenAPI 3.0规范文档，支持导出JSON/YAML格式

API信息

API标题

版本

描述

服务器URL

基础路径

API端点

快捷模板

OpenAPI规范

{
  "openapi": "3.0.0",
  "info": {
    "title": "My API",
    "version": "1.0.0",
    "description": "API Description"
  },
  "servers": [
    {
      "url": "https://api.example.com/v1"
    }
  ],
  "paths": {
    "/users": {
      "get": {
        "summary": "List users",
        "description": "Get all users",
        "responses": {
          "200": {
            "description": "Success"
          }
        }
      },
      "post": {
        "summary": "Create user",
        "description": "Create a new user",
        "responses": {
          "200": {
            "description": "Success"
          }
        }
      }
    },
    "/users/{id}": {
      "get": {
        "summary": "Get user",
        "description": "Get user by ID",
        "responses": {
          "200": {
            "description": "Success"
          }
        }
      }
    }
  }
}

OpenAPI规范说明

Info

API的元数据信息，包括标题、版本、描述、联系人等。

Paths

定义API端点和操作，每个路径可以包含多个HTTP方法。

Components

可重用的数据模型、安全方案、参数等定义。