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
Copy file name to clipboardExpand all lines: modules/ROOT/pages/chapter04/chapter04.adoc
+7-12Lines changed: 7 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1337,7 +1337,7 @@ This makes it easy for API consumers to understand authentication requirements a
1337
1337
1338
1338
== Summary
1339
1339
1340
-
In this chapter, you explored how MicroProfile OpenAPI 4.1 enables automatic generation of comprehensive, OpenAPI v3.1-compliant documentation for your RESTful web services. When you integrate MicroProfile OpenAPI into your Jakarta REST applications, you can create well-documented APIs that are discoverable, understandable, and easy to consume.
1340
+
In this chapter, you explored how MicroProfile OpenAPI 4.1 enables automatic generation of comprehensive, OpenAPI v3.1-compliant documentation for your RESTful web services.
1341
1341
1342
1342
=== Core concepts mastered
1343
1343
@@ -1355,20 +1355,17 @@ You learned how MicroProfile OpenAPI 4.1 fully supports OpenAPI v3.1, bringing i
1355
1355
1356
1356
You explored how MicroProfile OpenAPI 4.1 provides native support for Java records, which allows you to use modern, immutable data carriers like `CategoryRecord` with automatic schema generation. You learned to combine `@Schema` annotations with `@NotNull` validation to create well-documented, type-safe data models.
1357
1357
1358
-
*Enhanced type safety*
1359
-
You discovered how explicit `@Target` meta-annotations improve compile-time checking and IDE support, which helps you use OpenAPI annotations correctly and prevents misuse during development.
1360
-
1361
1358
*JSON Schema dialects*
1362
1359
1363
-
You learned to specify JSON Schema dialects programmatically using the `jsonSchemaDialect` property, which enables better compatibility with external validators and tooling. You explored the differences between the default OpenAPI 3.1 dialect and full JSON Schema 2020-12 support.
1360
+
You learned to specify JSON Schema dialects programmatically using the `jsonSchemaDialect` property enabling better compatibility with external validators and tooling.
1364
1361
1365
1362
*Vendor extensions*
1366
1363
1367
-
You explored the new `hasExtension()` and `getExtension()` convenience methods that simplify working with vendor extensions (`x-` properties). Through practical examples with `ExtensionFilter`, you learned how to read existing extensions and dynamically add metadata to your OpenAPI documentation for API gateway configuration, monitoring, and policy enforcement.
1364
+
You explored the new `hasExtension()` and `getExtension()` convenience methods that simplify working with vendor extensions (`x-` properties). Through practical examples with `ExtensionFilter`, you learned how to read existing extensions and dynamically add metadata to your OpenAPI documentation.
1368
1365
1369
1366
*Asynchronous operations*
1370
1367
1371
-
You learned to document asynchronous operations using the `@Callback` annotation, which is essential for webhook-style APIs. Using the `AsyncProductRequest` and `ProcessResult` models, you documented how your API initiates async processing and notifies clients when operations complete.
1368
+
You learned to document asynchronous operations using the `@Callback` annotation. You documented how your API initiates async processing and notifies clients when operations complete.
1372
1369
1373
1370
*Security schemes*
1374
1371
@@ -1380,16 +1377,14 @@ Having finished this chapter, you can now:
1380
1377
1381
1378
* Generate OpenAPI 3.1 specifications automatically from Jakarta REST code
1382
1379
* Document endpoints using `@Operation`, `@APIResponse`, and `@Tag` annotations
1383
-
* Construct type-safe schemas using Java records and `@Schema`
1384
-
* Handle flexible schemas for dynamic attributes
1385
-
* Document asynchronous operations with callbacks
1386
-
* Configure multiple security schemes
1387
1380
* Add OAS filters for dynamic documentation
1388
1381
* Test APIs interactively with Swagger UI
1382
+
* Document asynchronous operations with callbacks
1383
+
* Configure multiple security schemes
1389
1384
1390
1385
=== Practical applications
1391
1386
1392
-
MicroProfile OpenAPI 4.1's alignment with OpenAPI v3.1 guarentees your API documentation ahdres to the latest standards in the API landscape. This annotation-driven approach keeps documentation in sync with your implementation, thereby avoiding the common problem of outdated specifications. The generated OpenAPI documents facilities:
1387
+
MicroProfile OpenAPI 4.1's alignment with OpenAPI v3.1 guarentees your API documentation adheres to the latest standards in the API landscape. This annotation-driven approach keeps documentation in sync with your implementation, thereby avoiding the common problem of outdated specifications. The generated OpenAPI documents facilities:
1393
1388
1394
1389
* Automatic client SDK generation across multiple programming languages
0 commit comments