Add doc on excluding endpoints in controller-based apps #33773
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
captainsafia
reviewed
Oct 3, 2024
|
|
||
| In controller-based apps, the <xref:Microsoft.AspNetCore.Mvc.ApiExplorerSettingsAttribute> attribute can be used to exclude an endpoint from the OpenAPI document. | ||
|
|
||
| The following example demonstrates how to exclude an endpoint from the generated OpenAPI document. |
There was a problem hiding this comment.
Do we want to add that this also applies for committing entire controller classes?
captainsafia
approved these changes
Oct 3, 2024
Rick-Anderson
approved these changes
Oct 3, 2024
Comment on lines
+331
to
+332
| By default, all endpoints that are defined in an app are documented in the generated OpenAPI file, | ||
| but endpoints can be excluded from the document using attributes or extension methods. |
There was a problem hiding this comment.
Suggested change
| By default, all endpoints that are defined in an app are documented in the generated OpenAPI file, | |
| but endpoints can be excluded from the document using attributes or extension methods. | |
| By default, all endpoints that are defined in an app are documented in the generated OpenAPI file, but endpoints can be excluded from the document using attributes or extension methods. |
|
|
||
| By default, all endpoints that are defined in an app are documented in the generated OpenAPI file. Minimal APIs support two strategies for excluding a given endpoint from the OpenAPI document, using: | ||
| The mechanism for specifying an endpoint should be excluded depends on the type of app being developed. |
There was a problem hiding this comment.
Suggested change
| The mechanism for specifying an endpoint should be excluded depends on the type of app being developed. | |
| The mechanism for specifying an endpoint that should be excluded depends on the type of app being developed. |
|
|
||
| ##### [Minimal APIs](#tab/minimal-apis) | ||
|
|
||
| Minimal APIs support two strategies for excluding a given endpoint from the OpenAPI document, using: |
There was a problem hiding this comment.
Suggested change
| Minimal APIs support two strategies for excluding a given endpoint from the OpenAPI document, using: | |
| Minimal APIs support two strategies for excluding a given endpoint from the OpenAPI document: |
|
|
||
| In controller-based apps, the <xref:Microsoft.AspNetCore.Mvc.ApiExplorerSettingsAttribute> attribute can be used to exclude an endpoint from the OpenAPI document. | ||
|
|
||
| The following example demonstrates how to exclude an endpoint from the generated OpenAPI document. |
There was a problem hiding this comment.
Suggested change
| The following example demonstrates how to exclude an endpoint from the generated OpenAPI document. | |
| The following example demonstrates how to exclude an endpoint from the generated OpenAPI document: |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR updates the section of the OpenAPI doc on excluding endpoints to describe how this can be done in controller-based apps.
fixes: dotnet/aspnetcore#57425
Internal previews