I'm writing swagger documentation for an API, and the "description" fields are getting pretty long, and hard to edit.
{
"openapi": "3.0.0",
"info": {
"version": "2.0.0",
"title": "My API",
"description": "<h2>A very very long description</h2><p>which includes html tags</p>",
...
},
"paths": {
"/somepath": {
"get": {
"description": "<h3>Another</h3><p>extremely long description... </p><p>that wraps over 50 lines</p>",
...
}
},
...
},
These descriptions are important, because the first one shows on top when a user views the swagger page; and other descriptions appear at the beginning of each path.
I'm being asked to add some more stuff into descriptions.
Would it be possible to have description in a separate file, and then import/include it?
question from:
https://stackoverflow.com/questions/65834586/in-swagger-openapi-file-can-i-have-description-in-a-separate-file 与恶龙缠斗过久,自身亦成为恶龙;凝视深渊过久,深渊将回以凝视…