Swagger openapi 3.0.x пустое тело - PullRequest
Новая
       28

Swagger openapi 3.0.x пустое тело

0 голосов
/ 31 октября 2019

Я пытаюсь перенести мой из swagger 2.0 в openapi 3.0.2 для моего экспресс-API. Определения и пути swagger записаны в swagger-jsdoc. Это не должно вызывать проблем, потому что в их документации указано, что она может работать с openapi 3.x, а также с swagger 2.0.

При добавлении openapi: 3.0.x в мое swaggerDefinition представления выглядят нормально. Однако при попытке сделать пост-запрос через свагерские представления тело пусто.

Мое определение сваггера выглядит так: 

const swaggerOptions = {
    swaggerDefinition: {
        openapi: '3.0.2',
        info: {
            title: `Channels API`,
            description: "Channels API",
            version: "v1"
        },
        servers: [ {
            url: "http://127.0.0.1:3000",
            description: 'Local server'
        }],
    },
    apis: ['./routes/*.js'],
};

Теперь у меня есть файл channel.js какМаршрутизатор: в нем есть следующее определение: 

class Channel extends BaseRouter {
/**
* @swagger
*
* definitions:
*   channel:
*     type: object
*     tags:
*       - Channels
*     properties:
*       name:
*           type: string
*       global:
*           type: boolean
*     required:
*       - name
*/

constructor(app, version) {
    super(app, new ChannelCtrl(), version);
}

post() {
    /**
     * @swagger
     * /api/v1/channels:
     *  post:
     *      tags:
     *          - Channels
     *      name: Create
     *      produces:
     *          - application/json
     *      consumes:
     *          - application/json
     *      summary: Create new channel object
     *      parameters:
     *       - name: channel
     *         required: true
     *         in: body
     *         description: Fields of the channel object to be created
     *         type: object
     *         schema:
     *             $ref: '#/definitions/channel'
     *      responses:
     *          '200':
     *              description: Channel object has been created
     *              application/json:
     *                  schema:
     *                      $ref: '#/definitions/channel'
     */
    this.app.post(`/api/${this.version}/channels`, this.controller.create.bind(this.controller));
    return this;
}

Попытка его с Swagger 2.0, кажется, работает нормально. Что мне не хватает?

...