Skip to content

Commit d9cca08

Browse files
committed
Update readme file
1 parent 19337bd commit d9cca08

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

Diff for: README.md

+6
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,12 @@ It will listen on the IP address `0.0.0.0`, which means all the available IP add
102102

103103
In most cases you would (and should) have a "termination proxy" handling HTTPS for you on top, this will depend on how you deploy your application, your provider might do this for you, or you might need to set it up yourself. You can learn more about it in the <a href="https://fastapi.tiangolo.com/deployment/" class="external-link" target="_blank">FastAPI Deployment documentation</a>.
104104

105+
## `fastapi schema`
106+
107+
When you run `fastapi schema`, it will generate a swagger/openapi document.
108+
109+
This document will be output to stderr by default, however `--output <filename>` option can be used to write output into file. You can control the format of the JSON file by specifying indent level with `--indent #`. If set to 0, JSON will be in the minimal/compress form. Default is 2 spaces.
110+
105111
## License
106112

107113
This project is licensed under the terms of the MIT license.

0 commit comments

Comments
 (0)