You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Nov 13, 2021. It is now read-only.
Copy file name to clipboardExpand all lines: maturity-level-one/README.md
+5-7Lines changed: 5 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -148,23 +148,21 @@ OpenAPI tooling, such as [AutoRest](https://github.com/Azure/autorest) & [NSwag]
148
148
### Generating OpenAPI Documentation
149
149
Every API should have documentation in the OpenAPI format. If you want to generate those based on your code you can use tools like [Swashbuckle](https://github.com/domaindrivendev/Swashbuckle) & [NSwag](https://github.com/RSuter/NSwag).
150
150
151
-
Naming convention for **OperationId** is composed of `{Controller}_{OperationName}`
152
-
153
151
Here is an example on how to generate them with Swashbuckle
154
152
```csharp
155
153
/// <summary>
156
154
/// Get Player Profiles
157
155
/// </summary>
158
156
/// <paramname="topPlayersOnly">Indicates whether to return the top players only</param>
159
-
/// <remarks>Operation description here</remarks>
157
+
/// <remarks>Provides a profile for all known players</remarks>
160
158
/// <returns>Return a list of Players</returns>
161
159
[HttpGet(Name="Players_GetPlayers")]
162
160
[SwaggerResponse((int)HttpStatusCode.OK, "List of players")]
163
161
[SwaggerResponse((int)HttpStatusCode.InternalServerError, "API is not available")]
0 commit comments