Skip to content

Commit 8cdb235

Browse files
AXIS2-6100 Add REST support for OpenAPI (formerly known as Swagger)
1 parent ace9aee commit 8cdb235

File tree

3 files changed

+10
-2
lines changed

3 files changed

+10
-2
lines changed

src/site/xdoc/docs/openapi-rest-userguide.xml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ interactive <a href="https://swagger.io/tools/swagger-ui/">Swagger UI</a> docume
4545
(Spring Boot, Express.js, etc.) while maintaining API compatibility for frontend applications
4646
such as Excel Add-ins, React apps, and TypeScript clients.</p>
4747

48-
<p><strong>New in Axis2 2.0:</strong> Complete OpenAPI 3.0.1 integration with automatic specification
48+
<p><strong>New in Axis2 2.0.1:</strong> Complete OpenAPI 3.0.1 integration with automatic specification
4949
generation, Swagger UI support, and flexible generation modes (AUTOMATIC/STATIC/HYBRID) designed
5050
for real-world enterprise usage patterns.</p>
5151

@@ -136,6 +136,8 @@ distribution</a>.</p>
136136
<p>The sample provides a complete financial services API demonstrating authentication,
137137
data management, and calculation services with full OpenAPI 3.0.1 documentation.</p>
138138

139+
<p><strong>Testing the Sample:</strong> The swagger-server sample includes comprehensive unit tests for all service components and models. To run the tests, navigate to the sample directory and execute <code>mvn test</code>. The test suite covers authentication flows, data validation, JSON serialization/deserialization, and service method functionality. Individual test classes can be found in <code>src/test/java/org/apache/axis2/samples/swagger</code> and provide excellent examples of how to test REST services with custom authentication patterns and complex data models.</p>
140+
139141
<h2>Creating OpenAPI REST Services</h2>
140142

141143
<p>The guide demonstrates how to create secure, OpenAPI-documented REST services using

src/site/xdoc/docs/toc.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Guide</a></li>
5454
Guide</a></li>
5555
<li><a href="adv-userguide.html">Advanced User's
5656
Guide</a></li>
57-
<li><strong><a href="openapi-rest-userguide.html">OpenAPI REST Services Guide</a></strong>
57+
<li><a href="openapi-rest-userguide.html">OpenAPI REST Services Guide</a>
5858
<ul>
5959
<li>7.1 <a href="openapi-rest-userguide.html#Introduction">Getting Started with OpenAPI</a></li>
6060
<li>7.2 <a href="openapi-rest-userguide.html#OpenAPI_Integration_Features">OpenAPI Integration Features</a></li>

src/site/xdoc/index.xml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -160,6 +160,12 @@ supports the creation of Web Services using JavaScript Object Notation, with <a
160160
build POJO based services that receive and return JSON.</p>
161161
</li>
162162
<li>
163+
<p style="margin-bottom: 0in"><strong>OpenAPI support</strong> - Axis2
164+
supports automatic generation of <a href=
165+
"https://spec.openapis.org/oas/latest.html">OpenAPI 3.0</a> specifications for REST and JSON services, with integrated <a href=
166+
"https://swagger.io/tools/swagger-ui/">Swagger UI</a> for interactive API documentation and testing, enabling modern API development workflows.</p>
167+
</li>
168+
<li>
163169
<p style="margin-bottom: 0in"><strong>Composition and
164170
Extensibility</strong> - Modules and phases improve support for
165171
composability and extensibility. Modules support composability and

0 commit comments

Comments
 (0)