Я пытаюсь добавить Implementation Notes
и Description
в свой интерфейс Swagger. Тем не менее, ни один не появляется на пользовательском интерфейсе при реализации, как показано ниже:Добавление примечаний по реализации и описание для Swagger UI
{
"swagger" : "2.0",
"info" : {
"description" : "The definition of the Rest API to service plugin over https on port 9443.",
"version" : "1.0",
"title" : "Plugin Rest API",
"contact" : {
"name" : "John Doe",
"email" : "[email protected]"
}
},
"basePath" : "/service",
"tags" : [ {
"name" : "service"
} ],
"schemes" : [ "https" ],
"paths" : {
"/entry" : {
"get" : {
"notes" : "This is a note",
"method" : "get",
"tags" : [ "service" ],
"summary" : "Get an entry by first name and last name",
"description" : "This is a description",
"operationId" : "getEntry",
"produces" : [ "application/xml", "application/json" ],
"parameters" : [ {
"name" : "first",
"in" : "query",
"description" : "The first name",
"required" : true,
"type" : "string"
}, {
"name" : "last",
"in" : "query",
"description" : "The last name",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "Matching entry, or entries, if any, were returned",
"schema" : {
"$ref" : "#/definitions/Service"
}
}
}
},
Я не уверен, что я делаю неправильно в моем коде. Я тестировал его на разных образцах swagger.json, и я не могу заставить его работать.
Какие поля не отображаются? Резюме, описание и т. Д.? – fehguy
описание и примечания @fehguy – SVN600