Могут ли пути восстановления узлов работать с чванством?

Question

Библиотека node-restify позволяет такие пути, как /foo/:id, Может ли чванство справиться с такими путями? то есть как то?

var getFoo = {
    'spec': {
        'description': 'foo library',
        'path': '/foo/:id',
        'summary': 'return foo by id',
        'type': 'string',
        'produces': ['application/json']
    },
    'action': getFooObject()
};
swagger.addGet(getFoo)

Когда я пытаюсь это сделать в своем приложении, http://locahost:3001/api-docs страница выглядит так:

{
    apiVersion: "0.0.1",
    swaggerVersion: "1.2",
    apis: [ 
        {
            path: "/foo"
        }
    ]
}

Я пытался избежать двойного двоеточия с \ персонаж. Но это не имело значения. Также попытался заменить одинарные кавычки на двойные. Все еще никакой разницы. Я использую библиотеку swagger-node-restify, которая является форком из репозитория swagger -node. Что я делаю неправильно?

Answer 1

Вы описываете проект Swagger 1.2, который имеет несколько файлов для его описания. Вы можете прочитать больше о спецификации Swagger 1.2 здесь:

https://github.com/OAI/OpenAPI-Specification/blob/master/versions/1.2.md

Из-за этого ваш API не будет описан на api-docs место нахождения. Это должно быть показано на api-docs/foo на основе вашего описания выше.

Обратите внимание /api-docs называется списком ресурсов, и он указывает на декларацию Api, которая размещается относительно api-docs как /foo,

Последнее замечание: swagger spec 1.2 устарел, а набор инструментов для 2.0 намного лучше. Подумайте об обновлении вашего проекта до swagger-узла или другого