lims_adapter/swaggerui/swagger.yml

openapi: 3.0.0
info:
    title: learning
    description: 培训考试
    version: 0.0.1

paths:
    /Test.Nullable:
      post:
        tags:
          - 测试
        operationId: Test.Nullable
        summary: 测试空值参数
        requestBody:
          required: true
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/Nullable'
              examples:
                AllPass:
                  $ref: '#/components/examples/NullableReqAllPass'
        responses:
          200:
            description: 请求成功
            content:
              application/json:
                examples:
                  success:
                    $ref: "#/components/examples/success"

    /LearningSkill.List:
      post:
        tags:
          - 考试培训-技能
        operationId: LearningSkill.List
        summary: 技能列表
        requestBody:
          required: true
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/NoArgs'
              examples:
                NoArgs:
                  $ref: '#/components/examples/NoArgs'
        responses:
          200:
            description: 请求成功
            content:
              application/json:
                examples:
                  success:
                    $ref: "#/components/examples/success"

    /LearningSkill.Get:
      post:
        tags:
          - 考试培训-技能
        operationId: LearningSkill.Get
        summary: 技能详情
        requestBody:
          required: true
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/LearningSkillGet'
              examples:
                LearningSkillGet:
                  $ref: '#/components/examples/LearningSkillGet'
        responses:
          200:
            description: 请求成功
            content:
              application/json:
                examples:
                  success:
                    $ref: "#/components/examples/success"

    /LearningSkill.Add:
      post:
        tags:
          - 考试培训-技能
        operationId: LearningSkill.Add
        summary: 添加技能
        requestBody:
          required: true
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/LearningSkillAdd'
              examples:
                LearningSkillAdd:
                  $ref: '#/components/examples/LearningSkillAdd'
        responses:
          200:
            description: 请求成功
            content:
              application/json:
                examples:
                  success:
                    $ref: "#/components/examples/success"

    /LearningSkill.Update:
      post:
        tags:
          - 考试培训-技能
        operationId: LearningSkill.Update
        summary: 更新技能
        requestBody:
          required: true
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/LearningSkillUpdate'
              examples:
                LearningSkillUpdate:
                  $ref: '#/components/examples/LearningSkillUpdate'
        responses:
          200:
            description: 请求成功
            content:
              application/json:
                examples:
                  success:
                    $ref: "#/components/examples/success"

    /LearningSkill.Delete:
      post:
        tags:
          - 考试培训-技能
        operationId: LearningSkill.Delete
        summary: 删除技能
        requestBody:
          required: true
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/IdReq'
              examples:
                LearningSkillDelete:
                  $ref: '#/components/examples/LearningSkillDelete'
        responses:
          200:
            description: 请求成功
            content:
              application/json:
                examples:
                  success:
                    $ref: "#/components/examples/success"

# 添加这个 swagger ui 会显示授权按钮
security:
  - bearerAuth: []

components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    bearerAuth:
        type: http
        scheme: bearer
  schemas:
    Nullable:
      type: object
      required:
        - Str
        - Int
        - Bool
        - Slice
      properties:
        Str:
          type: string
          description: 字符串参数
        Int:
          type: integer
          description: Int 参数
        Bool:
          type: boolean
          description: Bool 参数
        Slice:
          type: array
          description: Slice 参数
          items:
            type: integer
    NoArgs:
      type: object
      properties:
        noargs:
          type: string
          description: 无参数，但是 body 中必须传输一个 json 空对象 "{}"
    LearningSkillGet:
      properties:
        id:
          type: string
          description: 技能 id
        name:
          type: string
          description: 技能名称
    LearningSkillAdd:
      properties:
        instrumentId:
          type: string
          description: 技能关联的设备 id
        name:
          type: string
          description: 技能名称
    LearningSkillUpdate:
      properties:
        id:
          type: string
          description: 技能 id
        instrumentId:
          type: string
          description: 技能关联的设备 id
        name:
          type: string
          description: 技能名称
    IdReq:
      type: object
      required:
        - id
      properties:
        id:
          type: integer
          description: ID

  examples:
    success:
      summary: 请求成功
      value:
        code: 200,
        msg: "success"
    NullableReqAllPass:
      value:
          Str: ""
          Int: 0
          Bool: false
          Slice: []
    NoArgs:
      value:
        noargs: ""
    LearningSkillGet:
      value:
        Id: 1
    LearningSkillAdd:
      value:
        name: 测试
        instrumentId: [1,2]
    LearningSkillUpdate:
      value:
        name: 测试更新
        instrumentId: [3,4]
        id: 1
    LearningSkillDelete:
      value:
        id: 1