Могут ли узловые регенерирующие пути работать с swagger?

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, в котором есть несколько файлов для его описания. Вы можете прочитать больше о развязности 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 1.2 старая, а оснастка для 2.0 намного лучше. Рассмотрите возможность обновления вашего проекта до swagger-node или другого.