openapi.yaml

# Generated with protoc-gen-openapi
# https://github.com/google/gnostic/tree/master/cmd/protoc-gen-openapi

openapi: 3.0.3
info:
    title: UserInfoService API
    description: The UserInfo service definition.
    version: 0.0.1
paths:
    /userInfo/delete:
        post:
            tags:
                - UserInfoService
            operationId: UserInfoService_Delete
            requestBody:
                content:
                    application/json:
                        schema:
                            $ref: '#/components/schemas/IdRequest'
                required: true
            responses:
                "200":
                    description: OK
                    content:
                        application/json:
                            schema:
                                $ref: '#/components/schemas/CommReply'
                default:
                    description: Default error response
                    content:
                        application/json:
                            schema:
                                $ref: '#/components/schemas/Status'
    /userInfo/get/{id}:
        get:
            tags:
                - UserInfoService
            operationId: UserInfoService_Get
            parameters:
                - name: id
                  in: path
                  required: true
                  schema:
                    type: integer
                    format: int64
            responses:
                "200":
                    description: OK
                    content:
                        application/json:
                            schema:
                                $ref: '#/components/schemas/UserInfoReply'
                default:
                    description: Default error response
                    content:
                        application/json:
                            schema:
                                $ref: '#/components/schemas/Status'
    /userInfo/list:
        post:
            tags:
                - UserInfoService
            operationId: UserInfoService_List
            requestBody:
                content:
                    application/json:
                        schema:
                            $ref: '#/components/schemas/ListRequest'
                required: true
            responses:
                "200":
                    description: OK
                    content:
                        application/json:
                            schema:
                                $ref: '#/components/schemas/ListUserInfoReply'
                default:
                    description: Default error response
                    content:
                        application/json:
                            schema:
                                $ref: '#/components/schemas/Status'
    /userInfo/save:
        post:
            tags:
                - UserInfoService
            operationId: UserInfoService_Save
            requestBody:
                content:
                    application/json:
                        schema:
                            $ref: '#/components/schemas/UserInfo'
                required: true
            responses:
                "200":
                    description: OK
                    content:
                        application/json:
                            schema:
                                $ref: '#/components/schemas/CommReply'
                default:
                    description: Default error response
                    content:
                        application/json:
                            schema:
                                $ref: '#/components/schemas/Status'
components:
    schemas:
        CommReply:
            type: object
            properties:
                code:
                    type: integer
                    format: int64
                message:
                    type: string
            description: return replay
        GoogleProtobufAny:
            type: object
            properties:
                '@type':
                    type: string
                    description: The type of the serialized message.
            additionalProperties: true
            description: Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.
        IdRequest:
            type: object
            properties:
                id:
                    type: integer
                    format: int64
        ListRequest:
            type: object
            properties:
                name:
                    type: string
        ListUserInfoReply:
            type: object
            properties:
                code:
                    type: integer
                    format: int64
                message:
                    type: string
                userInfoList:
                    type: array
                    items:
                        $ref: '#/components/schemas/UserInfo'
        Status:
            type: object
            properties:
                code:
                    type: integer
                    description: The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
                    format: int32
                message:
                    type: string
                    description: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
                details:
                    type: array
                    items:
                        $ref: '#/components/schemas/GoogleProtobufAny'
                    description: A list of messages that carry the error details.  There is a common set of message types for APIs to use.
            description: 'The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).'
        UserInfo:
            type: object
            properties:
                id:
                    type: integer
                    format: int64
                userName:
                    type: string
                password:
                    type: string
                age:
                    type: integer
                    format: uint32
                phone:
                    type: string
                address:
                    type: string
            description: https://developers.google.cn/protocol-buffers/docs/proto3 定义一个公用类型
        UserInfoReply:
            type: object
            properties:
                code:
                    type: integer
                    format: int64
                message:
                    type: string
                userInfo:
                    $ref: '#/components/schemas/UserInfo'
tags:
    - name: UserInfoService