Rename Swagger/OpenApi File

I’m submitting a…

[ ] Regression 
[x] Bug report
[x] Feature request
[ ] Documentation issue or request
[ ] Support request => Please do not submit support request here, instead post your question on Stack Overflow.

Current behavior

The current OpenApi Schema file is called FILENAME-json, however this is against the standard / recommendation.

Expected behavior

i think, we should rename the file “deployed” OpenAPI Schema file. Currently it is called FILENAME-json (note the -), however, the official “OpenAPI Spec” suggests that the file should be called openapi.json

OpenApi V3

It is RECOMMENDED that the root OpenAPI document be named: openapi.json or openapi.yaml.

( see https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/3.0.0.md#documentStructure )

Although it is “only” a recommendation, i think we should stick to this!

OpenApi 2

By convention, the Swagger specification file is named swagger.json.

(see https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/2.0.md#file-structure )

What is the motivation / use case for changing the behavior?

It bothers me that it does not follow the official recommendations / standards 😟

[kamilmysliwiec]

Notice that document in setup() method is not being modified at all. Hence, you can simply save document value:

const document = SwaggerModule.createDocument(app, options);
// save `document` to file

[lock[bot]]

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.