swagger 简介

weixin_38287114

已于 2023-12-04 17:03:13 修改

阅读量85

点赞数

分类专栏：社会的毒打文章标签：测试工具

于 2023-12-04 15:31:42 首次发布

本文链接：https://blog.csdn.net/weixin_38287114/article/details/134784933

版权

社会的毒打专栏收录该内容

20 篇文章 0 订阅

订阅专栏

开发文档链接（里面有各种参数的介绍）

OpenAPI Specification - Version 3.0.3 | Swagger

在线编辑（直接在线编辑到它不报错不然空格之类的容易错，他有一个离线的版本但是那个东西不知道为啥我跑不起来报一个swagger-router找不到的错，所以我没办法就用在线编辑，编辑完了下下来就是可以用的）

Swagger Editor

简单编辑后我的yaml内容

openapi: 3.0.3
info:
  title: Swagger Petstore - OpenAPI 3.0
  description: |-
    This is a sample Pet Store Server based on the OpenAPI 3.0 specification.  You can find out more about
    Swagger at [https://swagger.io](https://swagger.io). In the third iteration of the pet store, we've switched to the design first approach!
    You can now help us improve the API whether it's by making changes to the definition itself or to the code.
    That way, with time, we can improve the API in general, and expose some of the new features in OAS3.

    _If you're looking for the Swagger 2.0/OAS 2.0 version of Petstore, then click [here](https://editor.swagger.io/?url=https://petstore.swagger.io/v2/swagger.yaml). Alternatively, you can load via the `Edit > Load Petstore OAS 2.0` menu option!_

    Some useful links:
    - [The Pet Store repository](https://github.com/swagger-api/swagger-petstore)
    - [The source API definition for the Pet Store](https://github.com/swagger-api/swagger-petstore/blob/master/src/main/resources/openapi.yaml)
  termsOfService: http://swagger.io/terms/
  contact:
    email: apiteam@swagger.io
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  version: 1.0.11
externalDocs:
  description: Find out more about Swagger
  url: http://swagger.io
servers:
- url: http://localhost:8080/docs
tags:
- name: myapi
  description: my own api
paths:
  /00/002/003/004:
    get:
      tags:
      - myapi
      summary: Get user by user name
      description: ""
      operationId: getmyresponse
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/ApiResponse'
        "400":
          description: Invalid username supplied
        "404":
          description: User not found
      x-swagger-router-controller: Myapi
components:
  schemas:
    ApiResponse:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/ApiResponse_id'
      example:
        id:
          a.id: ppp
    ApiResponse_id:
      type: object
      properties:
        a.id:
          type: string
          example: ppp
      example:
        a.id: ppp

下载下来