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
Some of the changes you will see in the generated OpenAPI document include:
14
-
- Nullable types will no longer have the `nullable: true` property in the schema, and instead will have a `type` keyword whose value is an array that includes `null` as one of the types.
15
12
16
-
With this feature, the default OpenAPI version for generated documents will be 3.1, but you can easily change this
17
-
by explicitly setting the `OpenApiVersion` property of the `OpenApiOptions` in the `configureOptions` delegate
18
-
parameter of `AddOpenApi`.
13
+
- Nullable types no longer have the `nullable: true` property in the schema.
14
+
- Instead of a `nullable: true` property, they have a `type` keyword whose value is an array that includes `null` as one of the types.
15
+
16
+
With this feature, the default OpenAPI version for generated documents will be `3.1` . You can easily change the version
17
+
by explicitly setting the [OpenApiVersion](/dotnet/api/microsoft.aspnetcore.openapi.openapioptions.openapiversion?view=aspnetcore-9.0) property of the [OpenApiOptions](/dotnet/api/microsoft.aspnetcore.openapi.openapioptions?view=aspnetcore-9.0) in the `configureOptions` delegate parameter of [AddOpenApi](/dotnet/api/microsoft.extensions.dependencyinjection.openapiservicecollectionextensions.addopenapi?view=aspnetcore-9.0).
If you are generating the OpenAPI document at build time, you can select the OpenAPI version by setting the `--openapi-version` in the `OpenApiGenerateDocumentsOptions` MSBuild item.
27
+
When generating the OpenAPI document at build time, the OpenAPI version can be selected by setting the `--openapi-version` in the `OpenApiGenerateDocumentsOptions` MSBuild item.
29
28
30
29
```xml
31
30
<!-- Configure build-time OpenAPI generation to produce an OpenAPI 3.0 document. -->
OpenAPI 3.1 support was primarly added in the following this [PR](https://github.com/dotnet/aspnetcore/pull/59480).
35
+
36
+
35
37
### Breaking changes
36
38
37
-
Support for OpenAPI 3.1 requires an update to the underlying OpenAPI.NET library to a new major version, 2.0.
38
-
This new version has some breaking changes from the previous version, and this may impact your applications
39
-
if you have any document, operation, or schema transformers.
40
-
Perhaps the most significant change is that the `OpenApiAny` class has been dropped in favor of using `JsonNode` directly.
41
-
If your transformers use `OpenApiAny`, you will need to update them to use `JsonNode` instead.
42
-
For example, a schema transformer to add an example in .NET 9 might look like this:
39
+
Support for OpenAPI 3.1 requires an update to the underlying OpenAPI.NET library to a new major version, 2.0. This new version has some breaking changes from the previous version. The breaking changes may impact apps if they have any document, operation, or schema transformers.
40
+
41
+
One of the most significant changes is that the `OpenApiAny` class has been dropped in favor of using `JsonNode` directly.If your transformers use `OpenApiAny`, you will need to update them to use `JsonNode` instead. For example, a schema transformer to add an example in .NET 9 might look like the following:
@@ -77,22 +76,21 @@ In .NET 10 the transformer to do the same task will look like this:
77
76
});
78
77
```
79
78
80
-
Note that these changes will be necessary even if you congfigure the OpenAPI version to 3.0.
79
+
Note that these changes are necessary even when only congfiguring the OpenAPI version to 3.0.
81
80
82
81
### OpenAPI in Yaml
83
82
84
83
https://github.com/dotnet/aspnetcore/pull/58616
85
84
86
-
ASP.NET now supports serving the generated OpenAPI document in YAML format.
87
-
YAML can be more concise than JSON, eliminating curly braces and quotation marks when these can be inferred.
88
-
YAML also supports multi-line strings, which can be useful for long descriptions.
85
+
ASP.NET now supports serving the generated OpenAPI document in YAML format. YAML can be more concise than JSON, eliminating curly braces and quotation marks when these can be inferred. YAML also supports multi-line strings, which can be useful for long descriptions.
89
86
90
-
To configure your application to serve the generated OpenAPI document in YAML format,
91
-
specify the endpoint in the MapOpenApi call with a ".yaml" or ".yml" suffix, as shown in this example:
87
+
To configure an app to serve the generated OpenAPI document in YAML format, specify the endpoint in the MapOpenApi call with a ".yaml" or ".yml" suffix, as shown in the following example:
92
88
93
89
```csharp
94
90
app.MapOpenApi("/openapi/{documentName}.yaml");
95
91
```
96
92
97
-
Support for YAML is currently only available for the the OpenAPI served from the OpenAPI endpoint.
98
-
Support for generating OpenAPI documents in YAML format at build time will be added in a future preview.
93
+
Support for:
94
+
95
+
* YAML is currently only available for the the OpenAPI served from the OpenAPI endpoint.
96
+
* Generating OpenAPI documents in YAML format at build time will be added in a future preview.
The ProducesAttribute, ProducesResponseTypeAttribute, and ProducesDefaultResponseType attributes now accept an optional string parameter, `Description`, that will set the description of the response. Here's an example:
3
+
The [ProducesAttribute](/dotnet/api/microsoft.aspnetcore.mvc.producesattribute-1?view=aspnetcore-9.0), [ProducesResponseTypeAttribute](/dotnet/api/microsoft.aspnetcore.mvc.producesresponsetypeattribute-1?view=aspnetcore-9.0), and [ProducesDefaultResponseType](/dotnet/api/microsoft.aspnetcore.mvc.producesdefaultresponsetypeattribute?view=aspnetcore-9.0) attributes now accept an optional string parameter, `Description`, that will set the description of the response. Here's an example:
6
4
7
5
```csharp
8
6
[HttpGet(Name="GetWeatherForecast")]
@@ -11,7 +9,7 @@ public IEnumerable<WeatherForecast> Get()
11
9
{
12
10
```
13
11
14
-
AndthegeneratedOpenAPIwillbe
12
+
AndthegeneratedOpenAPI:
15
13
16
14
```json
17
15
"responses": {
@@ -20,4 +18,4 @@ And the generated OpenAPI will be
20
18
"content": {
21
19
```
22
20
23
-
Communitycontribution! 🙏
21
+
[Communitycontribution](https://github.com/dotnet/aspnetcore/pull/58193) by [Sander ten Brinke](https://github.com/sander1095) 🙏
0 commit comments