JSON-RPC Swagger UI - Open API

[qertis]

Продолжение перехода к Open API

Примеры конфига
OAI/OpenAPI-Specification#664 (comment)
OAI/OpenAPI-Specification#664 (comment)

express-openapi
https://github.com/kogosoftwarellc/open-api/tree/master/packages/express-openapi

[qertis]

Swagger не поддерживает JSON-RPC. Есть вариант выбрать OpenAPI. Пример конфига - https://gist.github.com/thephez/c6b46572c950593f7704f71442a6c733

[qertis]

Сделал конфиг для двух методов ping и help

openapi: 3.0.0
info:
  version: 1.0.0
  title: Simple API
  description: A simple API to illustrate OpenAPI concepts

servers:
  - url: 0.0.0.0:9000

components:
  securitySchemes:
    BasicAuth:
      type: http
      scheme: digest
security:
  - BasicAuth: []

paths:
  /:
    get:
      description: Returns a list of artists 
      responses:
        '200':
          description: OK   

  /api/ping:
    post:
      operationId: example Ping
      deprecated: false
      summary: Example of JSON-RPC2 Post
      description: Example post using JSON-RPC params.
      tags: [JSONRPC]    
      parameters: []
      responses:
        '200':
          description: OK
      requestBody:
        content: 
          application/json: 
            schema: 
              type: object
              required:
                - method
                - id
                - jsonrpc
                - params
              properties:
                method:
                  type: string
                  default: ping
                  description: API method name
                id:
                  type: integer
                  default: 1
                  format: int32
                  description: Request ID
                jsonrpc:
                  type: string
                  default: '2.0'
                  description: JSON-RPC Version (2.0)
                params:
                  title: Parameters
                  type: object
                  required: [id]
                  properties:
                    id:
                      type: integer
                      default: 1,
                      description: A param to include
         
  /api/help:
    post:
      operationId: example Help
      deprecated: false
      summary: Example HELP
      description: Example HELP JSON-RPC params.
      tags: [JSONRPC]
      parameters: []
      responses:
        '200':
          description: Successful response
      requestBody:
        content: 
          application/json: 
            schema: 
              type: object
              required:
                - method
                - id
                - jsonrpc
                - params
              properties:
                method:
                  type: string
                  default: help
                  description: API method name
                id:
                  type: integer
                  default: 1
                  format: int32
                  description: Request ID
                jsonrpc:
                  type: string
                  default: '2.0'
                  description: JSON-RPC Version (2.0)
                params:
                  title: Parameters
                  type: object
                  required: [id]
                  properties:
                    id:
                      type: integer
                      default: 1,
                      description: A param to include
                 

Теперь надо сделать его автогенерацию

[qertis]

Автогенерацию лучше делать используя - https://github.com/kogosoftwarellc/open-api/tree/master/packages/express-openapi. Не хочется делать свой велосипед, думаю будет проще доработать текущий с добавлением JSON-RPC на jayson

[qertis]

Генерация будет доступна по урлу /spec

[qertis]

сделал пакет https://www.npmjs.com/package/openapi-jsonrpc-jsdoc