Skip to content

Commit 64032f9

Browse files
committed
docs(openapi): mention another usage of OpenAPIObject
1 parent 1c1d18e commit 64032f9

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

content/openapi/introduction.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,8 @@ The `SwaggerModule` automatically reflects all of your endpoints. Note that the
6464

6565
> info **Hint** To generate and download a Swagger JSON file, navigate to `http://localhost:3000/api-json` in your browser (assuming that your Swagger documentation is available under `http://localhost:3000/api`).
6666
67+
> `const document` above is a serializable object conforming to [OpenAPI Document](https://swagger.io/specification/#openapi-document). Instead of hosting it via HTTP, you could also save it as a json / yaml file, and consume it in different ways.
68+
6769
#### Example
6870

6971
A working example is available [here](https://github.com/nestjs/nest/tree/master/sample/11-swagger).

0 commit comments

Comments
 (0)