Skip to content

Commit a291209

Browse files
authored
Enhance clarity and readability of OpenAPI section
Rephrase and clarify the explanation of the OpenAPI Specification and its benefits, improving readability and consistency.
1 parent 247b1c7 commit a291209

1 file changed

Lines changed: 4 additions & 5 deletions

File tree

modules/ROOT/pages/chapter04/chapter04.adoc

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ MicroProfile OpenAPI 4.1 introduces the following enhancements:
3434

3535
== OpenAPI Specification
3636

37-
The OpenAPI Specification (OAS), formerly known as Swagger, defines a standard format for describing and publishing REST APIs. It provides a language-agnostic interface to RESTful APIs. API providers use OAS to create machine-readable documents that describe their endpoints, request and response schemas, authentication requirements, and other API characteristics. This standardization enables powerful tooling: IDEs can generate client code automatically, testing frameworks can validate your API against its specification, and documentation tools can create interactive API explorers from a single OpenAPI document.
37+
The OpenAPI Specification (OAS), formerly known as Swagger, defines a standard format for describing and publishing REST APIs. It provides a language-agnostic interface to RESTful APIs. API providers use OAS to create machine-readable documents that describe their endpoints, request and response schemas, authentication requirements, and other API characteristics. This standardization enables powerful tooling: Integrated Development Environments (IDEs) can automatically generate client code. Testing frameworks can then verify your API's functionality against its specification. Furthermore, Documentation tools can build interactive API explorers, all stemming from a single OpenAPI document.
3838

3939
[NOTE]
4040
====
@@ -76,16 +76,15 @@ Add annotations to your Jakarta REST resources to generate documentation with Mi
7676

7777
=== Annotation-based generation
7878

79-
Annotate your Jakarta REST classes and methods with OpenAPI annotations. MicroProfile OpenAPI scans your application at build time, discovers annotated endpoints, and generates a complete OpenAPI specification automatically.
79+
You can use OpenAPI annotations to mark up your Jakarta REST classes and methods. MicroProfile OpenAPI then scans your application during the build time, automatically discovering the annotated endpoints, and producing a full OpenAPI specification.
8080

81-
This approach offers several benefits:
81+
This approach has several advantages:
8282

8383
* Documentation lives alongside the code it describes
84-
* IDE (Integrated Development Environment) support for autocomplete and validation
84+
* IDEs can provide support for autocomplete and validation features.
8585
* Compile-time checking ensures annotations remain valid
8686
* No separate specification files to maintain
8787

88-
8988
== Generating OpenAPI documents
9089

9190
There are multiple ways in which you can generate OpenAPI documents. The most common way is to use annotations. This only requires augmenting your Jakarta Restful Web Services annotations with OpenAPI annotations.

0 commit comments

Comments
 (0)