Skip to content

Commit daf84ec

Browse files
Correct naming and output for build-time generated OpenAPI documents
1 parent c87cfc8 commit daf84ec

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

aspnetcore/fundamentals/openapi/aspnetcore-openapi.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -175,11 +175,11 @@ dotnet add package Microsoft.Extensions.ApiDescription.Server
175175
```
176176
---
177177

178-
Upon installation, this package will automatically generate the Open API document(s) associated with the application during build and populate them into the application's output directory.
178+
Upon installation, this package will automatically generate the Open API document(s) associated with the application during build and populate them into the application's output directory. The OpenAPI document name is per default `{ProjectName}.json`. If multiple documents are registered, then it is post-fixed with the document name - unless the document name is `v1`. E.g., `{ProjectName}_{DocumentName}.json`.
179179

180180
```cli
181181
$ dotnet build
182-
$ cat bin/Debug/net9.0/{ProjectName}.json
182+
$ cat {ProjectName}/obj/{ProjectName}.json
183183
```
184184

185185
### Customizing build-time document generation

0 commit comments

Comments
 (0)