用Docker轻松搭建Swagger环境 |
您所在的位置：网站首页 › openapi工具 › 用Docker轻松搭建Swagger环境 |
用Docker轻松搭建Swagger环境
|
用Docker轻松搭建Swagger环境
概要
我将介绍如何构建运行在 Docker 上的 Swagger 环境。 成果 Swagger Editor网页的左侧是编辑器，右侧是Swagger UI，可以实时查看notation和查看定义文档。 如果将稍后描述的示例复制并粘贴到左侧，结果将显示在右侧，所以请尝试一下。 访问网址：http://localhost:8003/users [{"id":100,"name":"Taro","status":"pending"}] 复制代码 测试环境 macOS Big Sur 11.4 Docker 20.10.7 Docker Compose version v2.0.0-beta.6 所需文件这次只准备了以下2个文件！ . ├── api │ └── openapi.yaml └── docker-compose.yml 复制代码 步骤 1.创建docker-compose.yml这一次，我们将为 swagger 编辑器、UI 和 API 模拟准备容器。 version: '3.9' services: swagger-editor: image: swaggerapi/swagger-editor container_name: "swagger-editor" ports: - "8001:8080" swagger-ui: image: swaggerapi/swagger-ui container_name: "swagger-ui" ports: - "8002:8080" volumes: - ./api/openapi.yaml:/openapi.yaml environment: SWAGGER_JSON: /openapi.yaml swagger-api: image: stoplight/prism:3 container_name: "swagger-api" ports: - "8003:4010" command: mock -h 0.0.0.0 /openapi.yaml volumes: - ./api/openapi.yaml:/openapi.yaml 复制代码 2.创建openapi.yaml为示例准备 API 设计文档。 基于此 openapi: 3.0.0 info: version: 1.0.0 title: Sample API description: >- A sample API that uses a sample-site as an example to demonstrate features in the OpenAPI 3.0 specification servers: - url: 'http://localhost:8003' paths: /users: get: description: > Returns all users operationId: findUsers parameters: - name: tags in: query description: tags to filter by required: false style: form schema: type: array items: type: string - name: limit in: query description: maximum number of results to return required: false schema: type: integer format: int32 responses: '200': description: user response content: application/json: schema: type: array items: $ref: '#/components/schemas/User' default: description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' components: schemas: User: type: "object" required: - "name" properties: id: type: "integer" format: "int64" example: 100 name: type: "string" example: "Taro" status: type: "string" description: "user status" enum: - "pending" - "active" - "inactive" Error: type: "object" properties: code: type: "integer" format: "int32" type: type: "string" message: type: "string" externalDocs: description: "Find out more about Swagger" url: "http://swagger.io" 复制代码 启动 docker-compose up -d 复制代码确认用URL 名称网址Swagger Editorhttp://localhost:8001/Swagger UIhttp://localhost:8002/Swagger API 模拟访问http://localhost:8003/users 参考资料 OpenAPI (Swagger) 超入門 Swagger OpenAPIでAPI Referenceを書く 原文翻译自：DockerでSwagger環境簡単構築！ |
【本文地址】
今日新闻 |
推荐新闻 |