{"id":106513,"date":"2020-08-26T10:00:57","date_gmt":"2020-08-26T07:00:57","guid":{"rendered":"https:\/\/www.javacodegeeks.com\/?p=106513"},"modified":"2020-08-24T13:06:47","modified_gmt":"2020-08-24T10:06:47","slug":"microprofile-openapi-for-everyone","status":"publish","type":"post","link":"https:\/\/www.javacodegeeks.com\/2020\/08\/microprofile-openapi-for-everyone.html","title":{"rendered":"MicroProfile OpenAPI for everyone"},"content":{"rendered":"

MicroProfile OpenAPI<\/a> is primarily used for adding OpenAPI<\/a> to JAX-RS<\/a> Endpoints. In this blog post we will look at how the SmallRye Implementation<\/a> extends this with some extra features, and support for more web frameworks, when used in Quarkus.<\/p>\n

Using Quarkus<\/h2>\n

The example code is available here<\/a>. You can also initialize a project using code.quarkus.io<\/a> – just make sure to include the SmallRye OpenAPI Extension.<\/p>\n

JAX-RS<\/h2>\n

Let\u2019s start with a basic JAX-RS Example in Quarkus. We have a Greeting<\/code> Object, that has a message<\/code> and a to<\/code> field, and we will create GET<\/code>, POST<\/code> and DELETE<\/code> endpoints for the greeting.<\/p>\n

Apart from the usual Quarkus setup, you also need the following in your pom.xml<\/code> to create a JAX-RS Endpoint:<\/p>\n

\n
\n\n\n\n
\n
01<\/div>\n
02<\/div>\n
03<\/div>\n
04<\/div>\n
05<\/div>\n
06<\/div>\n
07<\/div>\n
08<\/div>\n
09<\/div>\n
10<\/div>\n
11<\/div>\n
12<\/div>\n
13<\/div>\n
14<\/div>\n<\/td>\n
\n
\n
<dependency><\/code><\/div>\n
        <\/code><groupId>io.quarkus<\/groupId><\/code><\/div>\n
        <\/code><artifactId>quarkus-smallrye-openapi<\/artifactId><\/code><\/div>\n
    <\/code><\/dependency><\/code><\/div>\n
 <\/div>\n
    <\/code><dependency><\/code><\/div>\n
        <\/code><groupId>io.quarkus<\/groupId><\/code><\/div>\n
        <\/code><artifactId>quarkus-resteasy<\/artifactId><\/code><\/div>\n
    <\/code><\/dependency><\/code><\/div>\n
 <\/div>\n
    <\/code><dependency><\/code><\/div>\n
        <\/code><groupId>io.quarkus<\/groupId><\/code><\/div>\n
        <\/code><artifactId>quarkus-resteasy-jsonb<\/artifactId><\/code><\/div>\n
    <\/code><\/dependency><\/code><\/div>\n<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<\/div>\n

In Quarkus you do not need an Application<\/code> class, we can just add the Endpoint class:<\/p>\n

\n
\n\n\n\n
\n
01<\/div>\n
02<\/div>\n
03<\/div>\n
04<\/div>\n
05<\/div>\n
06<\/div>\n
07<\/div>\n
08<\/div>\n
09<\/div>\n
10<\/div>\n
11<\/div>\n
12<\/div>\n
13<\/div>\n
14<\/div>\n
15<\/div>\n
16<\/div>\n
17<\/div>\n
18<\/div>\n
19<\/div>\n
20<\/div>\n
21<\/div>\n
22<\/div>\n
23<\/div>\n<\/td>\n
\n
\n
@Path<\/code>(<\/code>\"\/jax-rs\"<\/code>)<\/code><\/div>\n
@Produces<\/code>(MediaType.APPLICATION_JSON)<\/code><\/div>\n
@Consumes<\/code>(MediaType.APPLICATION_JSON)<\/code><\/div>\n
public<\/code> class<\/code> JaxRsGreeting {<\/code><\/div>\n
 <\/div>\n
    <\/code>@GET<\/code><\/div>\n
    <\/code>@Path<\/code>(<\/code>\"\/hello\"<\/code>)<\/code><\/div>\n
    <\/code>public<\/code> Greeting helloJaxRs() {<\/code><\/div>\n
        <\/code>return<\/code> new<\/code> Greeting(<\/code>\"Hello\"<\/code>, <\/code>\"JAX-RS\"<\/code>);<\/code><\/div>\n
    <\/code>}<\/code><\/div>\n
 <\/div>\n
    <\/code>@POST<\/code><\/div>\n
    <\/code>@Path<\/code>(<\/code>\"\/hello\"<\/code>)<\/code><\/div>\n
    <\/code>public<\/code> Greeting newHelloJaxRs(Greeting greeting) {<\/code><\/div>\n
        <\/code>return<\/code> greeting;<\/code><\/div>\n
    <\/code>}<\/code><\/div>\n
 <\/div>\n
    <\/code>@DELETE<\/code><\/div>\n
    <\/code>@Path<\/code>(<\/code>\"\/hello\/{message}\"<\/code>)<\/code><\/div>\n
    <\/code>public<\/code> void<\/code> deleteHelloJaxRs(<\/code>@PathParam<\/code>(<\/code>\"message\"<\/code>) String message) {<\/code><\/div>\n
        <\/code>\/\/ Here do the delete.<\/code><\/div>\n
    <\/code>}<\/code><\/div>\n
}<\/code><\/div>\n<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<\/div>\n

So far we have not yet added any MicroProfile OpenAPI Annotations, but because we added the quarkus-smallrye-openapi<\/code> extension, we will already have a Schema document generated under \/openapi<\/code>:<\/p>\n

\n
\n\n\n\n
\n
01<\/div>\n
02<\/div>\n
03<\/div>\n
04<\/div>\n
05<\/div>\n
06<\/div>\n
07<\/div>\n
08<\/div>\n
09<\/div>\n
10<\/div>\n
11<\/div>\n
12<\/div>\n
13<\/div>\n
14<\/div>\n
15<\/div>\n
16<\/div>\n
17<\/div>\n
18<\/div>\n
19<\/div>\n
20<\/div>\n
21<\/div>\n
22<\/div>\n
23<\/div>\n
24<\/div>\n
25<\/div>\n
26<\/div>\n
27<\/div>\n
28<\/div>\n
29<\/div>\n
30<\/div>\n
31<\/div>\n
32<\/div>\n
33<\/div>\n
34<\/div>\n
35<\/div>\n
36<\/div>\n
37<\/div>\n
38<\/div>\n
39<\/div>\n
40<\/div>\n
41<\/div>\n
42<\/div>\n
43<\/div>\n
44<\/div>\n
45<\/div>\n
46<\/div>\n
47<\/div>\n
48<\/div>\n<\/td>\n
\n
\n
---<\/code><\/div>\n
openapi: <\/code>3.0<\/code>.<\/code>3<\/code><\/div>\n
info:<\/code><\/div>\n
  <\/code>title: Generated API<\/code><\/div>\n
  <\/code>version: <\/code>\"1.0\"<\/code><\/div>\n
paths:<\/code><\/div>\n
  <\/code>\/jax-rs\/hello:<\/code><\/div>\n
    <\/code>get:<\/code><\/div>\n
      <\/code>responses:<\/code><\/div>\n
        <\/code>\"200\"<\/code>:<\/code><\/div>\n
          <\/code>description: OK<\/code><\/div>\n
          <\/code>content:<\/code><\/div>\n
            <\/code>application\/json:<\/code><\/div>\n
              <\/code>schema:<\/code><\/div>\n
                <\/code>$ref: <\/code>'#\/components\/schemas\/Greeting'<\/code><\/div>\n
    <\/code>post:<\/code><\/div>\n
      <\/code>requestBody:<\/code><\/div>\n
        <\/code>content:<\/code><\/div>\n
          <\/code>application\/json:<\/code><\/div>\n
            <\/code>schema:<\/code><\/div>\n
              <\/code>$ref: <\/code>'#\/components\/schemas\/Greeting'<\/code><\/div>\n
      <\/code>responses:<\/code><\/div>\n
        <\/code>\"200\"<\/code>:<\/code><\/div>\n
          <\/code>description: OK<\/code><\/div>\n
          <\/code>content:<\/code><\/div>\n
            <\/code>application\/json:<\/code><\/div>\n
              <\/code>schema:<\/code><\/div>\n
                <\/code>$ref: <\/code>'#\/components\/schemas\/Greeting'<\/code><\/div>\n
  <\/code>\/jax-rs\/hello\/{message}:<\/code><\/div>\n
    <\/code>delete:<\/code><\/div>\n
      <\/code>parameters:<\/code><\/div>\n
      <\/code>- name: message<\/code><\/div>\n
        <\/code>in: path<\/code><\/div>\n
        <\/code>required: <\/code>true<\/code><\/div>\n
        <\/code>schema:<\/code><\/div>\n
          <\/code>type: string<\/code><\/div>\n
      <\/code>responses:<\/code><\/div>\n
        <\/code>\"204\"<\/code>:<\/code><\/div>\n
          <\/code>description: No Content<\/code><\/div>\n
components:<\/code><\/div>\n
  <\/code>schemas:<\/code><\/div>\n
    <\/code>Greeting:<\/code><\/div>\n
      <\/code>type: object<\/code><\/div>\n
      <\/code>properties:<\/code><\/div>\n
        <\/code>message:<\/code><\/div>\n
          <\/code>type: string<\/code><\/div>\n
        <\/code>to:<\/code><\/div>\n
          <\/code>type: string<\/code><\/div>\n<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<\/div>\n

See quarkus.io\/guides\/rest-json<\/a> for more information.<\/p>\n

OpenAPI<\/h2>\n

You can add more information to the generated schema document by using MicroProfile OpenAPI.<\/p>\n

Header information using config<\/h3>\n

One feature that we added to SmallRye is the ability to add header information, that you typically add to the Application<\/code> class using annotations, with MicroProfile config. This is useful in Quarkus where you do not need an Application<\/code> class. So adding the following to the application.properties<\/code> will give you some header information:<\/p>\n

\n
\n\n\n\n
\n
01<\/div>\n
02<\/div>\n
03<\/div>\n
04<\/div>\n
05<\/div>\n
06<\/div>\n
07<\/div>\n
08<\/div>\n
09<\/div>\n
10<\/div>\n<\/td>\n
\n
\n
mp.openapi.extensions.smallrye.info.title=OpenAPI <\/code>for<\/code> Everyone<\/code><\/div>\n
%dev.mp.openapi.extensions.smallrye.info.title=OpenAPI <\/code>for<\/code> Everyone (development)<\/code><\/div>\n
%test.mp.openapi.extensions.smallrye.info.title=OpenAPI <\/code>for<\/code> Everyone (test)<\/code><\/div>\n
mp.openapi.extensions.smallrye.info.version=<\/code>1.0<\/code>.<\/code>0<\/code><\/div>\n
mp.openapi.extensions.smallrye.info.description=Example on how to use OpenAPI everywhere<\/code><\/div>\n
mp.openapi.extensions.smallrye.info.contact.email=phillip.kruger<\/code>@redhat<\/code>.com<\/code><\/div>\n
mp.openapi.extensions.smallrye.info.contact.name=Phillip Kruger<\/code><\/div>\n
mp.openapi.extensions.smallrye.info.contact.url=https:<\/code>\/\/www.phillip-kruger.com<\/code><\/div>\n
mp.openapi.extensions.smallrye.info.license.name=Apache <\/code>2.0<\/code><\/div>\n
mp.openapi.extensions.smallrye.info.license.url=http:<\/code>\/\/www.apache.org\/licenses\/LICENSE-2.0.html<\/code><\/div>\n<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<\/div>\n

Now look at the header of the generated schema document under \/openapi<\/code>:<\/p>\n

\n
\n\n\n\n
\n
01<\/div>\n
02<\/div>\n
03<\/div>\n
04<\/div>\n
05<\/div>\n
06<\/div>\n
07<\/div>\n
08<\/div>\n
09<\/div>\n
10<\/div>\n
11<\/div>\n
12<\/div>\n
13<\/div>\n
14<\/div>\n
15<\/div>\n<\/td>\n
\n
\n
---<\/code><\/div>\n
openapi: <\/code>3.0<\/code>.<\/code>3<\/code><\/div>\n
info:<\/code><\/div>\n
  <\/code>title: OpenAPI <\/code>for<\/code> Everyone (development)<\/code><\/div>\n
  <\/code>description: Example on how to use OpenAPI everywhere<\/code><\/div>\n
  <\/code>contact:<\/code><\/div>\n
    <\/code>name: Phillip Kruger<\/code><\/div>\n
    <\/code>url: https:<\/code>\/\/www.phillip-kruger.com<\/code><\/div>\n
    <\/code>email: phillip.kruger<\/code>@redhat<\/code>.com<\/code><\/div>\n
  <\/code>license:<\/code><\/div>\n
    <\/code>name: Apache <\/code>2.0<\/code><\/div>\n
    <\/code>url: http:<\/code>\/\/www.apache.org\/licenses\/LICENSE-2.0.html<\/code><\/div>\n
  <\/code>version: <\/code>1.0<\/code>.<\/code>0<\/code><\/div>\n
 <\/div>\n
  <\/code># rest of the schema document ...<\/code><\/div>\n<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<\/div>\n

Adding some OpenAPI Annotations to your operations<\/h3>\n

You can use any of the annotations in MicroProfile OpenAPI to further describe your endpoint, for example the Tag<\/code> annotation:<\/p>\n

\n
\n\n\n\n
\n
1<\/div>\n
2<\/div>\n
3<\/div>\n
4<\/div>\n
5<\/div>\n
6<\/div>\n
7<\/div>\n<\/td>\n
\n
\n
@Path<\/code>(<\/code>\"\/jax-rs\"<\/code>)<\/code><\/div>\n
@Produces<\/code>(MediaType.APPLICATION_JSON)<\/code><\/div>\n
@Consumes<\/code>(MediaType.APPLICATION_JSON)<\/code><\/div>\n
@Tag<\/code>(name = <\/code>\"JAX-RS Resource\"<\/code>, description = <\/code>\"Basic Hello World using JAX-RS\"<\/code>)<\/code><\/div>\n
public<\/code> class<\/code> JaxRsGreeting {<\/code><\/div>\n
    <\/code>\\\\...<\/code><\/div>\n
}<\/code><\/div>\n<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<\/div>\n

Auto generate the operation id<\/h3>\n

Some tools that use the schema document to generate client stubs, need an operationId<\/code> in the schema document that is used to name the client stub methods. We added support in SmallRye to auto generate this using either the method name (METHOD<\/code>), class and method name (CLASS_METHOD<\/code>), or package, class and method name (PACKAGE_CLASS_METHOD<\/code>). To do this add the following to application.properties<\/code>:<\/p>\n

\n
\n\n\n\n
\n
1<\/div>\n<\/td>\n
\n
\n
mp.openapi.extensions.smallrye.operationIdStrategy=METHOD<\/code><\/div>\n<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<\/div>\n

You will now see the operationId<\/code> in the schema document for every operation:<\/p>\n

\n
\n\n\n\n
\n
01<\/div>\n
02<\/div>\n
03<\/div>\n
04<\/div>\n
05<\/div>\n
06<\/div>\n
07<\/div>\n
08<\/div>\n
09<\/div>\n
10<\/div>\n
11<\/div>\n
12<\/div>\n
13<\/div>\n
14<\/div>\n
15<\/div>\n
16<\/div>\n
17<\/div>\n
18<\/div>\n
19<\/div>\n
20<\/div>\n
21<\/div>\n
22<\/div>\n
23<\/div>\n
24<\/div>\n
25<\/div>\n
26<\/div>\n
27<\/div>\n
28<\/div>\n
29<\/div>\n
30<\/div>\n
31<\/div>\n
32<\/div>\n
33<\/div>\n
34<\/div>\n
35<\/div>\n
36<\/div>\n
37<\/div>\n
38<\/div>\n
39<\/div>\n
40<\/div>\n
41<\/div>\n
42<\/div>\n
43<\/div>\n
44<\/div>\n
45<\/div>\n
46<\/div>\n
47<\/div>\n<\/td>\n
\n
\n
---<\/code><\/div>\n
openapi: <\/code>3.0<\/code>.<\/code>3<\/code><\/div>\n
 <\/div>\n
  <\/code># header omitted ...<\/code><\/div>\n
 <\/div>\n
  <\/code>\/jax-rs\/hello:<\/code><\/div>\n
    <\/code>get:<\/code><\/div>\n
      <\/code>tags:<\/code><\/div>\n
      <\/code>- JAX-RS Resource<\/code><\/div>\n
      <\/code>operationId: helloJaxRs<\/code><\/div>\n
      <\/code>responses:<\/code><\/div>\n
        <\/code>\"200\"<\/code>:<\/code><\/div>\n
          <\/code>description: OK<\/code><\/div>\n
          <\/code>content:<\/code><\/div>\n
            <\/code>application\/json:<\/code><\/div>\n
              <\/code>schema:<\/code><\/div>\n
                <\/code>$ref: <\/code>'#\/components\/schemas\/Greeting'<\/code><\/div>\n
    <\/code>post:<\/code><\/div>\n
      <\/code>tags:<\/code><\/div>\n
      <\/code>- JAX-RS Resource<\/code><\/div>\n
      <\/code>operationId: newHelloJaxRs<\/code><\/div>\n
      <\/code>requestBody:<\/code><\/div>\n
        <\/code>content:<\/code><\/div>\n
          <\/code>application\/json:<\/code><\/div>\n
            <\/code>schema:<\/code><\/div>\n
              <\/code>$ref: <\/code>'#\/components\/schemas\/Greeting'<\/code><\/div>\n
      <\/code>responses:<\/code><\/div>\n
        <\/code>\"200\"<\/code>:<\/code><\/div>\n
          <\/code>description: OK<\/code><\/div>\n
          <\/code>content:<\/code><\/div>\n
            <\/code>application\/json:<\/code><\/div>\n
              <\/code>schema:<\/code><\/div>\n
                <\/code>$ref: <\/code>'#\/components\/schemas\/Greeting'<\/code><\/div>\n
  <\/code>\/jax-rs\/hello\/{message}:<\/code><\/div>\n
    <\/code>delete:<\/code><\/div>\n
      <\/code>tags:<\/code><\/div>\n
      <\/code>- JAX-RS Resource<\/code><\/div>\n
      <\/code>operationId: deleteHelloJaxRs<\/code><\/div>\n
      <\/code>parameters:<\/code><\/div>\n
      <\/code>- name: message<\/code><\/div>\n
        <\/code>in: path<\/code><\/div>\n
        <\/code>required: <\/code>true<\/code><\/div>\n
        <\/code>schema:<\/code><\/div>\n
          <\/code>type: string<\/code><\/div>\n
      <\/code>responses:<\/code><\/div>\n
        <\/code>\"204\"<\/code>:<\/code><\/div>\n
          <\/code>description: No Content<\/code><\/div>\n<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<\/div>\n

Changing the OpenAPI version<\/h3>\n

Some API gateways might require a certain OpenAPI version to work. The schema document generated by the SmallRye extension will generate with a 3.0.3<\/code> as the version, but since there is only minor differences between these versions, you can change that to 3.0.0<\/code>, 3.0.1<\/code> or 3.0.2<\/code>. You can do this by adding this in application.properties<\/code>:<\/p>\n

\n
\n\n\n\n
\n
1<\/div>\n<\/td>\n
\n
\n
mp.openapi.extensions.smallrye.openapi=<\/code>3.0<\/code>.<\/code>2<\/code><\/div>\n<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<\/div>\n

Now the version generated will be:<\/p>\n

\n
\n\n\n\n
\n
1<\/div>\n
2<\/div>\n
3<\/div>\n
4<\/div>\n<\/td>\n
\n
\n
---<\/code><\/div>\n
openapi: <\/code>3.0<\/code>.<\/code>2<\/code><\/div>\n
 <\/div>\n
  <\/code># Rest of the document ...<\/code><\/div>\n<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<\/div>\n

See quarkus.io\/guides\/openapi-swaggerui<\/a> for more information.<\/p>\n

Spring Web<\/h2>\n

Recently support for Spring Web has been added in SmallRye, this means that, not only will you see the default OpenAPI document when you use Spring Web in Quarkus, but you can also use MicroProfile OpenAPI to further describe your Spring Web endpoints.

<\/div> <\/div><\/p>\n

Let\u2019s add a Spring Rest Controller to our current application. First add this in your pom.xml<\/code>:<\/p>\n

\n
\n\n\n\n
\n
1<\/div>\n
2<\/div>\n
3<\/div>\n
4<\/div>\n<\/td>\n
\n
\n
<dependency><\/code><\/div>\n
    <\/code><groupId>io.quarkus<\/groupId><\/code><\/div>\n
    <\/code><artifactId>quarkus-spring-web<\/artifactId><\/code><\/div>\n
<\/dependency><\/code><\/div>\n<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<\/div>\n

Now you can create a similar endpoint to the JAX-RS one we have looked at so far, but using Spring Web:<\/p>\n

\n
\n\n\n\n
\n
01<\/div>\n
02<\/div>\n
03<\/div>\n
04<\/div>\n
05<\/div>\n
06<\/div>\n
07<\/div>\n
08<\/div>\n
09<\/div>\n
10<\/div>\n
11<\/div>\n
12<\/div>\n
13<\/div>\n
14<\/div>\n
15<\/div>\n
16<\/div>\n
17<\/div>\n
18<\/div>\n
19<\/div>\n
20<\/div>\n<\/td>\n
\n
\n
@RestController<\/code><\/div>\n
@RequestMapping<\/code>(value = <\/code>\"\/spring\"<\/code>, produces = MediaType.APPLICATION_JSON_VALUE)<\/code><\/div>\n
@Tag<\/code>(name = <\/code>\"Spring Resource\"<\/code>, description = <\/code>\"Basic Hello World using Spring\"<\/code>)<\/code><\/div>\n
public<\/code> class<\/code> SpringGreeting {<\/code><\/div>\n
 <\/div>\n
    <\/code>@GetMapping<\/code>(<\/code>\"\/hello\"<\/code>)<\/code><\/div>\n
    <\/code>public<\/code> Greeting helloSpring() {<\/code><\/div>\n
        <\/code>return<\/code> new<\/code> Greeting(<\/code>\"Hello\"<\/code>, <\/code>\"Spring\"<\/code>);<\/code><\/div>\n
    <\/code>}<\/code><\/div>\n
 <\/div>\n
    <\/code>@PostMapping<\/code>(<\/code>\"\/hello\"<\/code>)<\/code><\/div>\n
    <\/code>public<\/code> Greeting newHelloSpring(<\/code>@RequestBody<\/code> Greeting greeting) {<\/code><\/div>\n
        <\/code>return<\/code> greeting;<\/code><\/div>\n
    <\/code>}<\/code><\/div>\n
 <\/div>\n
    <\/code>@DeleteMapping<\/code>(<\/code>\"\/hello\/{message}\"<\/code>)<\/code><\/div>\n
    <\/code>public<\/code> void<\/code> deleteHelloSpring(<\/code>@PathVariable<\/code>(name = <\/code>\"message\"<\/code>) String message) {<\/code><\/div>\n
 <\/div>\n
    <\/code>}<\/code><\/div>\n
}<\/code><\/div>\n<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<\/div>\n

The Spring annotations will be scanned and this will be added to your schema document:<\/p>\n

\n
\n\n\n\n
\n
01<\/div>\n
02<\/div>\n
03<\/div>\n
04<\/div>\n
05<\/div>\n
06<\/div>\n
07<\/div>\n
08<\/div>\n
09<\/div>\n
10<\/div>\n
11<\/div>\n
12<\/div>\n
13<\/div>\n
14<\/div>\n
15<\/div>\n
16<\/div>\n
17<\/div>\n
18<\/div>\n
19<\/div>\n
20<\/div>\n
21<\/div>\n
22<\/div>\n
23<\/div>\n
24<\/div>\n
25<\/div>\n
26<\/div>\n
27<\/div>\n
28<\/div>\n
29<\/div>\n
30<\/div>\n
31<\/div>\n
32<\/div>\n
33<\/div>\n
34<\/div>\n
35<\/div>\n
36<\/div>\n
37<\/div>\n
38<\/div>\n
39<\/div>\n
40<\/div>\n
41<\/div>\n
42<\/div>\n
43<\/div>\n
44<\/div>\n
45<\/div>\n
46<\/div>\n
47<\/div>\n<\/td>\n
\n
\n
---<\/code><\/div>\n
openapi: <\/code>3.0<\/code>.<\/code>3<\/code><\/div>\n
 <\/div>\n
  <\/code># header omitted ...<\/code><\/div>\n
 <\/div>\n
  <\/code>\/spring\/hello:<\/code><\/div>\n
    <\/code>get:<\/code><\/div>\n
      <\/code>tags:<\/code><\/div>\n
      <\/code>- Spring Resource<\/code><\/div>\n
      <\/code>operationId: helloSpring<\/code><\/div>\n
      <\/code>responses:<\/code><\/div>\n
        <\/code>\"200\"<\/code>:<\/code><\/div>\n
          <\/code>description: OK<\/code><\/div>\n
          <\/code>content:<\/code><\/div>\n
            <\/code>application\/json:<\/code><\/div>\n
              <\/code>schema:<\/code><\/div>\n
                <\/code>$ref: <\/code>'#\/components\/schemas\/Greeting'<\/code><\/div>\n
    <\/code>post:<\/code><\/div>\n
      <\/code>tags:<\/code><\/div>\n
      <\/code>- Spring Resource<\/code><\/div>\n
      <\/code>operationId: newHelloSpring<\/code><\/div>\n
      <\/code>requestBody:<\/code><\/div>\n
        <\/code>content:<\/code><\/div>\n
          <\/code>'*\/*'<\/code>:<\/code><\/div>\n
            <\/code>schema:<\/code><\/div>\n
              <\/code>$ref: <\/code>'#\/components\/schemas\/Greeting'<\/code><\/div>\n
      <\/code>responses:<\/code><\/div>\n
        <\/code>\"200\"<\/code>:<\/code><\/div>\n
          <\/code>description: OK<\/code><\/div>\n
          <\/code>content:<\/code><\/div>\n
            <\/code>application\/json:<\/code><\/div>\n
              <\/code>schema:<\/code><\/div>\n
                <\/code>$ref: <\/code>'#\/components\/schemas\/Greeting'<\/code><\/div>\n
  <\/code>\/spring\/hello\/{message}:<\/code><\/div>\n
    <\/code>delete:<\/code><\/div>\n
      <\/code>tags:<\/code><\/div>\n
      <\/code>- Spring Resource<\/code><\/div>\n
      <\/code>operationId: deleteHelloSpring<\/code><\/div>\n
      <\/code>parameters:<\/code><\/div>\n
      <\/code>- name: message<\/code><\/div>\n
        <\/code>in: path<\/code><\/div>\n
        <\/code>required: <\/code>true<\/code><\/div>\n
        <\/code>schema:<\/code><\/div>\n
          <\/code>type: string<\/code><\/div>\n
      <\/code>responses:<\/code><\/div>\n
        <\/code>\"204\"<\/code>:<\/code><\/div>\n
          <\/code>description: No Content<\/code><\/div>\n<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<\/div>\n

See quarkus.io\/guides\/spring-web<\/a> for more information.<\/p>\n

Vert.x Reactive Routes<\/h2>\n

In Quarkus, you can also build Vert.x endpoints using Reactive Routes. Similarly to Spring Web, your endpoints will be available in the OpenAPI Schema and can be further described using MicroProfile OpenAPI. To add a Vert.x reactive Route in Quarkus, you need the following in your pom.xml<\/code>:<\/p>\n

\n
\n\n\n\n
\n
1<\/div>\n
2<\/div>\n
3<\/div>\n
4<\/div>\n<\/td>\n
\n
\n
<dependency><\/code><\/div>\n
    <\/code><groupId>io.quarkus<\/groupId><\/code><\/div>\n
    <\/code><artifactId>quarkus-vertx-web<\/artifactId><\/code><\/div>\n
<\/dependency><\/code><\/div>\n<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<\/div>\n

Now you can create the endpoint:<\/p>\n

\n
\n\n\n\n
\n
01<\/div>\n
02<\/div>\n
03<\/div>\n
04<\/div>\n
05<\/div>\n
06<\/div>\n
07<\/div>\n
08<\/div>\n
09<\/div>\n
10<\/div>\n
11<\/div>\n
12<\/div>\n
13<\/div>\n
14<\/div>\n
15<\/div>\n
16<\/div>\n
17<\/div>\n
18<\/div>\n
19<\/div>\n
20<\/div>\n<\/td>\n
\n
\n
@ApplicationScoped<\/code><\/div>\n
@RouteBase<\/code>(path = <\/code>\"\/vertx\"<\/code>, produces = <\/code>\"application\/json\"<\/code>)<\/code><\/div>\n
@Tag<\/code>(name = <\/code>\"Vert.x Resource\"<\/code>, description = <\/code>\"Basic Hello World using Vert.x\"<\/code>)<\/code><\/div>\n
public<\/code> class<\/code> VertxGreeting {<\/code><\/div>\n
 <\/div>\n
    <\/code>@Route<\/code>(path = <\/code>\"\/hello\"<\/code>, methods = HttpMethod.GET)<\/code><\/div>\n
    <\/code>public<\/code> Greeting helloVertX() { <\/code><\/div>\n
        <\/code>return<\/code> new<\/code> Greeting(<\/code>\"Hello\"<\/code>, <\/code>\"Vert.x\"<\/code>);<\/code><\/div>\n
    <\/code>}<\/code><\/div>\n
 <\/div>\n
    <\/code>@Route<\/code>(path = <\/code>\"\/hello\"<\/code>, methods = HttpMethod.POST)<\/code><\/div>\n
    <\/code>public<\/code> Greeting newHelloVertX(<\/code>@Body<\/code> Greeting greeting) {<\/code><\/div>\n
        <\/code>return<\/code> greeting;<\/code><\/div>\n
    <\/code>}<\/code><\/div>\n
 <\/div>\n
    <\/code>@Route<\/code>(path = <\/code>\"\/hello\/:message\"<\/code>, methods = HttpMethod.DELETE)<\/code><\/div>\n
    <\/code>public<\/code> void<\/code> deleteHelloVertX(<\/code>@Param<\/code>(<\/code>\"message\"<\/code>) String message) {<\/code><\/div>\n
 <\/div>\n
    <\/code>}<\/code><\/div>\n
}<\/code><\/div>\n<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<\/div>\n

and now your Vert.x Routes are available in OpenAPI:<\/p>\n

\n
\n\n\n\n
\n
01<\/div>\n
02<\/div>\n
03<\/div>\n
04<\/div>\n
05<\/div>\n
06<\/div>\n
07<\/div>\n
08<\/div>\n
09<\/div>\n
10<\/div>\n
11<\/div>\n
12<\/div>\n
13<\/div>\n
14<\/div>\n
15<\/div>\n
16<\/div>\n
17<\/div>\n
18<\/div>\n
19<\/div>\n
20<\/div>\n
21<\/div>\n
22<\/div>\n
23<\/div>\n
24<\/div>\n
25<\/div>\n
26<\/div>\n
27<\/div>\n
28<\/div>\n
29<\/div>\n
30<\/div>\n
31<\/div>\n
32<\/div>\n
33<\/div>\n
34<\/div>\n
35<\/div>\n
36<\/div>\n
37<\/div>\n
38<\/div>\n
39<\/div>\n
40<\/div>\n
41<\/div>\n
42<\/div>\n
43<\/div>\n
44<\/div>\n
45<\/div>\n
46<\/div>\n
47<\/div>\n<\/td>\n
\n
\n
---<\/code><\/div>\n
openapi: <\/code>3.0<\/code>.<\/code>3<\/code><\/div>\n
 <\/div>\n
  <\/code># header omitted ...<\/code><\/div>\n
 <\/div>\n
  <\/code>\/vertx\/hello:<\/code><\/div>\n
    <\/code>get:<\/code><\/div>\n
      <\/code>tags:<\/code><\/div>\n
      <\/code>- Vert.x Resource<\/code><\/div>\n
      <\/code>operationId: helloVertX<\/code><\/div>\n
      <\/code>responses:<\/code><\/div>\n
        <\/code>\"200\"<\/code>:<\/code><\/div>\n
          <\/code>description: OK<\/code><\/div>\n
          <\/code>content:<\/code><\/div>\n
            <\/code>application\/json:<\/code><\/div>\n
              <\/code>schema:<\/code><\/div>\n
                <\/code>$ref: <\/code>'#\/components\/schemas\/Greeting'<\/code><\/div>\n
    <\/code>post:<\/code><\/div>\n
      <\/code>tags:<\/code><\/div>\n
      <\/code>- Vert.x Resource<\/code><\/div>\n
      <\/code>operationId: newHelloVertX<\/code><\/div>\n
      <\/code>requestBody:<\/code><\/div>\n
        <\/code>content:<\/code><\/div>\n
          <\/code>'*\/*'<\/code>:<\/code><\/div>\n
            <\/code>schema:<\/code><\/div>\n
              <\/code>$ref: <\/code>'#\/components\/schemas\/Greeting'<\/code><\/div>\n
      <\/code>responses:<\/code><\/div>\n
        <\/code>\"200\"<\/code>:<\/code><\/div>\n
          <\/code>description: OK<\/code><\/div>\n
          <\/code>content:<\/code><\/div>\n
            <\/code>application\/json:<\/code><\/div>\n
              <\/code>schema:<\/code><\/div>\n
                <\/code>$ref: <\/code>'#\/components\/schemas\/Greeting'<\/code><\/div>\n
  <\/code>\/vertx\/hello\/{message}:<\/code><\/div>\n
    <\/code>delete:<\/code><\/div>\n
      <\/code>tags:<\/code><\/div>\n
      <\/code>- Vert.x Resource<\/code><\/div>\n
      <\/code>operationId: deleteHelloVertX<\/code><\/div>\n
      <\/code>parameters:<\/code><\/div>\n
      <\/code>- name: message<\/code><\/div>\n
        <\/code>in: path<\/code><\/div>\n
        <\/code>required: <\/code>true<\/code><\/div>\n
        <\/code>schema:<\/code><\/div>\n
          <\/code>type: string<\/code><\/div>\n
      <\/code>responses:<\/code><\/div>\n
        <\/code>\"204\"<\/code>:<\/code><\/div>\n
          <\/code>description: No Content<\/code><\/div>\n<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<\/div>\n

See quarkus.io\/guides\/reactive-routes<\/a> for more information.<\/p>\n

Endpoints generated with Panache<\/h2>\n

In Quarkus your can generate your JAX-RS endpoint using Panache. These generated classes will also be scanned and added to the OpenAPI schema document if you have the quarkus-smallrye-openapi<\/code> extension in your pom.xml<\/code>.<\/p>\n

See quarkus.io\/guides\/rest-data-panache<\/a> for more information.<\/p>\n

Any other Web Framework<\/h2>\n

You can also add any other endpoint to your document by providing that part of the Schema document in a yaml<\/code> file. Let\u2019s say for instance you have a Servlet that exposes some methods and you want to add those to the schema document. Servlet is just an example, any web framework can work here.<\/p>\n

So first we add this to the pom.xml<\/code> to add Servlet support in Quarkus:<\/p>\n

\n
\n\n\n\n
\n
1<\/div>\n
2<\/div>\n
3<\/div>\n
4<\/div>\n<\/td>\n
\n
\n
<dependency><\/code><\/div>\n
    <\/code><groupId>io.quarkus<\/groupId><\/code><\/div>\n
    <\/code><artifactId>quarkus-undertow<\/artifactId><\/code><\/div>\n
<\/dependency><\/code><\/div>\n<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<\/div>\n

We can now create a Servlet Endpoint like this for example:<\/p>\n

\n
\n\n\n\n
\n
01<\/div>\n
02<\/div>\n
03<\/div>\n
04<\/div>\n
05<\/div>\n
06<\/div>\n
07<\/div>\n
08<\/div>\n
09<\/div>\n
10<\/div>\n
11<\/div>\n
12<\/div>\n
13<\/div>\n
14<\/div>\n
15<\/div>\n
16<\/div>\n
17<\/div>\n
18<\/div>\n
19<\/div>\n
20<\/div>\n
21<\/div>\n
22<\/div>\n
23<\/div>\n
24<\/div>\n
25<\/div>\n
26<\/div>\n<\/td>\n
\n
\n
@WebServlet<\/code>(<\/code>\"\/other\/hello\/*\"<\/code>)<\/code><\/div>\n
public<\/code> class<\/code> ServletGreeting <\/code>extends<\/code> HttpServlet {<\/code><\/div>\n
 <\/div>\n
    <\/code>private<\/code> static<\/code> final<\/code> Jsonb JSONB = JsonbBuilder.create();<\/code><\/div>\n
 <\/div>\n
    <\/code>@Override<\/code><\/div>\n
    <\/code>protected<\/code> void<\/code> doGet(HttpServletRequest request, HttpServletResponse response)<\/code>throws<\/code> ServletException, IOException {<\/code><\/div>\n
        <\/code>response.setContentType(<\/code>\"application\/json\"<\/code>);<\/code><\/div>\n
        <\/code>Greeting greeting = <\/code>new<\/code> Greeting(<\/code>\"Hello\"<\/code>, <\/code>\"Other\"<\/code>);<\/code><\/div>\n
        <\/code>PrintWriter out = response.getWriter();<\/code><\/div>\n
        <\/code>out.print(JSONB.toJson(greeting));<\/code><\/div>\n
    <\/code>}<\/code><\/div>\n
 <\/div>\n
    <\/code>@Override<\/code><\/div>\n
    <\/code>protected<\/code> void<\/code> doPost(HttpServletRequest request, HttpServletResponse response) <\/code>throws<\/code> ServletException, IOException {<\/code><\/div>\n
        <\/code>response.setContentType(<\/code>\"application\/json\"<\/code>);<\/code><\/div>\n
        <\/code>Greeting greeting = JSONB.fromJson(request.getInputStream(), Greeting.<\/code>class<\/code>);<\/code><\/div>\n
        <\/code>PrintWriter out = response.getWriter();<\/code><\/div>\n
        <\/code>out.print(JSONB.toJson(greeting));<\/code><\/div>\n
    <\/code>}<\/code><\/div>\n
 <\/div>\n
    <\/code>@Override<\/code><\/div>\n
    <\/code>protected<\/code> void<\/code> doDelete(HttpServletRequest request, HttpServletResponse response) <\/code>throws<\/code> ServletException, IOException {<\/code><\/div>\n
        <\/code>\/\/ Here do the delete<\/code><\/div>\n
    <\/code>}<\/code><\/div>\n
}<\/code><\/div>\n<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<\/div>\n

Now we need a OpenAPI Schema document that maps to these endpoints. You need to add this to a file called openapi.yml<\/code> in src\/main\/resources\/META-INF<\/code>:<\/p>\n

\n
\n\n\n\n
\n
01<\/div>\n
02<\/div>\n
03<\/div>\n
04<\/div>\n
05<\/div>\n
06<\/div>\n
07<\/div>\n
08<\/div>\n
09<\/div>\n
10<\/div>\n
11<\/div>\n
12<\/div>\n
13<\/div>\n
14<\/div>\n
15<\/div>\n
16<\/div>\n
17<\/div>\n
18<\/div>\n
19<\/div>\n
20<\/div>\n
21<\/div>\n
22<\/div>\n
23<\/div>\n
24<\/div>\n
25<\/div>\n
26<\/div>\n
27<\/div>\n
28<\/div>\n
29<\/div>\n
30<\/div>\n
31<\/div>\n
32<\/div>\n
33<\/div>\n
34<\/div>\n
35<\/div>\n
36<\/div>\n
37<\/div>\n
38<\/div>\n
39<\/div>\n
40<\/div>\n
41<\/div>\n
42<\/div>\n
43<\/div>\n
44<\/div>\n
45<\/div>\n
46<\/div>\n
47<\/div>\n
48<\/div>\n<\/td>\n
\n
\n
---<\/code><\/div>\n
openapi: <\/code>3.0<\/code>.<\/code>3<\/code><\/div>\n
tags:<\/code><\/div>\n
- name: Other Resource<\/code><\/div>\n
  <\/code>description: Basic Hello World using Something <\/code>else<\/code><\/div>\n
paths:<\/code><\/div>\n
  <\/code>\/other\/hello:<\/code><\/div>\n
    <\/code>get:<\/code><\/div>\n
      <\/code>tags:<\/code><\/div>\n
      <\/code>- Other Resource<\/code><\/div>\n
      <\/code>operationId: helloOther<\/code><\/div>\n
      <\/code>responses:<\/code><\/div>\n
        <\/code>\"200\"<\/code>:<\/code><\/div>\n
          <\/code>description: OK<\/code><\/div>\n
          <\/code>content:<\/code><\/div>\n
            <\/code>application\/json:<\/code><\/div>\n
              <\/code>schema:<\/code><\/div>\n
                <\/code>$ref: <\/code>'#\/components\/schemas\/Greeting'<\/code><\/div>\n
    <\/code>post:<\/code><\/div>\n
      <\/code>tags:<\/code><\/div>\n
      <\/code>- Other Resource<\/code><\/div>\n
      <\/code>operationId: newHelloOther<\/code><\/div>\n
      <\/code>requestBody:<\/code><\/div>\n
        <\/code>content:<\/code><\/div>\n
          <\/code>application\/json:<\/code><\/div>\n
            <\/code>schema:<\/code><\/div>\n
              <\/code>$ref: <\/code>'#\/components\/schemas\/Greeting'<\/code><\/div>\n
      <\/code>responses:<\/code><\/div>\n
        <\/code>\"200\"<\/code>:<\/code><\/div>\n
          <\/code>description: OK<\/code><\/div>\n
          <\/code>content:<\/code><\/div>\n
            <\/code>application\/json:<\/code><\/div>\n
              <\/code>schema:<\/code><\/div>\n
                <\/code>$ref: <\/code>'#\/components\/schemas\/Greeting'<\/code><\/div>\n
  <\/code>\/other\/hello\/{message}:<\/code><\/div>\n
    <\/code>delete:<\/code><\/div>\n
      <\/code>tags:<\/code><\/div>\n
      <\/code>- Other Resource<\/code><\/div>\n
      <\/code>operationId: deleteHelloOther<\/code><\/div>\n
      <\/code>parameters:<\/code><\/div>\n
      <\/code>- name: message<\/code><\/div>\n
        <\/code>in: path<\/code><\/div>\n
        <\/code>required: <\/code>true<\/code><\/div>\n
        <\/code>schema:<\/code><\/div>\n
          <\/code>type: string<\/code><\/div>\n
      <\/code>responses:<\/code><\/div>\n
        <\/code>\"204\"<\/code>:<\/code><\/div>\n
          <\/code>description: No Content<\/code><\/div>\n<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<\/div>\n

This will be merged with the rest of the endpoints to expose all paths in your document. So in the end your \/openapi<\/code> output will look like this:<\/p>\n

\n
\n\n\n\n
\n
001<\/div>\n
002<\/div>\n
003<\/div>\n
004<\/div>\n
005<\/div>\n
006<\/div>\n
007<\/div>\n
008<\/div>\n
009<\/div>\n
010<\/div>\n
011<\/div>\n
012<\/div>\n
013<\/div>\n
014<\/div>\n
015<\/div>\n
016<\/div>\n
017<\/div>\n
018<\/div>\n
019<\/div>\n
020<\/div>\n
021<\/div>\n
022<\/div>\n
023<\/div>\n
024<\/div>\n
025<\/div>\n
026<\/div>\n
027<\/div>\n
028<\/div>\n
029<\/div>\n
030<\/div>\n
031<\/div>\n
032<\/div>\n
033<\/div>\n
034<\/div>\n
035<\/div>\n
036<\/div>\n
037<\/div>\n
038<\/div>\n
039<\/div>\n
040<\/div>\n
041<\/div>\n
042<\/div>\n
043<\/div>\n
044<\/div>\n
045<\/div>\n
046<\/div>\n
047<\/div>\n
048<\/div>\n
049<\/div>\n
050<\/div>\n
051<\/div>\n
052<\/div>\n
053<\/div>\n
054<\/div>\n
055<\/div>\n
056<\/div>\n
057<\/div>\n
058<\/div>\n
059<\/div>\n
060<\/div>\n
061<\/div>\n
062<\/div>\n
063<\/div>\n
064<\/div>\n
065<\/div>\n
066<\/div>\n
067<\/div>\n
068<\/div>\n
069<\/div>\n
070<\/div>\n
071<\/div>\n
072<\/div>\n
073<\/div>\n
074<\/div>\n
075<\/div>\n
076<\/div>\n
077<\/div>\n
078<\/div>\n
079<\/div>\n
080<\/div>\n
081<\/div>\n
082<\/div>\n
083<\/div>\n
084<\/div>\n
085<\/div>\n
086<\/div>\n
087<\/div>\n
088<\/div>\n
089<\/div>\n
090<\/div>\n
091<\/div>\n
092<\/div>\n
093<\/div>\n
094<\/div>\n
095<\/div>\n
096<\/div>\n
097<\/div>\n
098<\/div>\n
099<\/div>\n
100<\/div>\n
101<\/div>\n
102<\/div>\n
103<\/div>\n
104<\/div>\n
105<\/div>\n
106<\/div>\n
107<\/div>\n
108<\/div>\n
109<\/div>\n
110<\/div>\n
111<\/div>\n
112<\/div>\n
113<\/div>\n
114<\/div>\n
115<\/div>\n
116<\/div>\n
117<\/div>\n
118<\/div>\n
119<\/div>\n
120<\/div>\n
121<\/div>\n
122<\/div>\n
123<\/div>\n
124<\/div>\n
125<\/div>\n
126<\/div>\n
127<\/div>\n
128<\/div>\n
129<\/div>\n
130<\/div>\n
131<\/div>\n
132<\/div>\n
133<\/div>\n
134<\/div>\n
135<\/div>\n
136<\/div>\n
137<\/div>\n
138<\/div>\n
139<\/div>\n
140<\/div>\n
141<\/div>\n
142<\/div>\n
143<\/div>\n
144<\/div>\n
145<\/div>\n
146<\/div>\n
147<\/div>\n
148<\/div>\n
149<\/div>\n
150<\/div>\n
151<\/div>\n
152<\/div>\n
153<\/div>\n
154<\/div>\n
155<\/div>\n
156<\/div>\n
157<\/div>\n
158<\/div>\n
159<\/div>\n
160<\/div>\n
161<\/div>\n
162<\/div>\n
163<\/div>\n
164<\/div>\n
165<\/div>\n
166<\/div>\n
167<\/div>\n
168<\/div>\n
169<\/div>\n
170<\/div>\n
171<\/div>\n
172<\/div>\n
173<\/div>\n
174<\/div>\n
175<\/div>\n
176<\/div>\n
177<\/div>\n
178<\/div>\n
179<\/div>\n
180<\/div>\n
181<\/div>\n
182<\/div>\n
183<\/div>\n
184<\/div>\n
185<\/div>\n
186<\/div>\n
187<\/div>\n
188<\/div>\n
189<\/div>\n
190<\/div>\n
191<\/div>\n
192<\/div>\n
193<\/div>\n
194<\/div>\n
195<\/div>\n
196<\/div>\n
197<\/div>\n
198<\/div>\n
199<\/div>\n
200<\/div>\n<\/td>\n
\n
\n
---<\/code><\/div>\n
openapi: <\/code>3.0<\/code>.<\/code>2<\/code><\/div>\n
info:<\/code><\/div>\n
  <\/code>title: OpenAPI <\/code>for<\/code> Everyone (development)<\/code><\/div>\n
  <\/code>description: Example on how to use OpenAPI everywhere<\/code><\/div>\n
  <\/code>contact:<\/code><\/div>\n
    <\/code>name: Phillip Kruger<\/code><\/div>\n
    <\/code>url: https:<\/code>\/\/www.phillip-kruger.com<\/code><\/div>\n
    <\/code>email: phillip.kruger<\/code>@redhat<\/code>.com<\/code><\/div>\n
  <\/code>license:<\/code><\/div>\n
    <\/code>name: Apache <\/code>2.0<\/code><\/div>\n
    <\/code>url: http:<\/code>\/\/www.apache.org\/licenses\/LICENSE-2.0.html<\/code><\/div>\n
  <\/code>version: <\/code>1.0<\/code>.<\/code>0<\/code><\/div>\n
tags:<\/code><\/div>\n
- name: Other Resource<\/code><\/div>\n
  <\/code>description: Basic Hello World using Something <\/code>else<\/code><\/div>\n
- name: Spring Resource<\/code><\/div>\n
  <\/code>description: Basic Hello World using Spring<\/code><\/div>\n
- name: JAX-RS Resource<\/code><\/div>\n
  <\/code>description: Basic Hello World using JAX-RS<\/code><\/div>\n
- name: Vert.x Resource<\/code><\/div>\n
  <\/code>description: Basic Hello World using Vert.x<\/code><\/div>\n
paths:<\/code><\/div>\n
  <\/code>\/other\/hello:<\/code><\/div>\n
    <\/code>get:<\/code><\/div>\n
      <\/code>tags:<\/code><\/div>\n
      <\/code>- Other Resource<\/code><\/div>\n
      <\/code>operationId: helloOther<\/code><\/div>\n
      <\/code>responses:<\/code><\/div>\n
        <\/code>\"200\"<\/code>:<\/code><\/div>\n
          <\/code>description: OK<\/code><\/div>\n
          <\/code>content:<\/code><\/div>\n
            <\/code>application\/json:<\/code><\/div>\n
              <\/code>schema:<\/code><\/div>\n
                <\/code>$ref: <\/code>'#\/components\/schemas\/Greeting'<\/code><\/div>\n
    <\/code>post:<\/code><\/div>\n
      <\/code>tags:<\/code><\/div>\n
      <\/code>- Other Resource<\/code><\/div>\n
      <\/code>operationId: newHelloOther<\/code><\/div>\n
      <\/code>requestBody:<\/code><\/div>\n
        <\/code>content:<\/code><\/div>\n
          <\/code>application\/json:<\/code><\/div>\n
            <\/code>schema:<\/code><\/div>\n
              <\/code>$ref: <\/code>'#\/components\/schemas\/Greeting'<\/code><\/div>\n
      <\/code>responses:<\/code><\/div>\n
        <\/code>\"200\"<\/code>:<\/code><\/div>\n
          <\/code>description: OK<\/code><\/div>\n
          <\/code>content:<\/code><\/div>\n
            <\/code>application\/json:<\/code><\/div>\n
              <\/code>schema:<\/code><\/div>\n
                <\/code>$ref: <\/code>'#\/components\/schemas\/Greeting'<\/code><\/div>\n
  <\/code>\/other\/hello\/{message}:<\/code><\/div>\n
    <\/code>delete:<\/code><\/div>\n
      <\/code>tags:<\/code><\/div>\n
      <\/code>- Other Resource<\/code><\/div>\n
      <\/code>operationId: deleteHelloOther<\/code><\/div>\n
      <\/code>parameters:<\/code><\/div>\n
      <\/code>- name: message<\/code><\/div>\n
        <\/code>in: path<\/code><\/div>\n
        <\/code>required: <\/code>true<\/code><\/div>\n
        <\/code>schema:<\/code><\/div>\n
          <\/code>type: string<\/code><\/div>\n
      <\/code>responses:<\/code><\/div>\n
        <\/code>\"204\"<\/code>:<\/code><\/div>\n
          <\/code>description: No Content<\/code><\/div>\n
  <\/code>\/jax-rs\/hello:<\/code><\/div>\n
    <\/code>get:<\/code><\/div>\n
      <\/code>tags:<\/code><\/div>\n
      <\/code>- JAX-RS Resource<\/code><\/div>\n
      <\/code>operationId: helloJaxRs<\/code><\/div>\n
      <\/code>responses:<\/code><\/div>\n
        <\/code>\"200\"<\/code>:<\/code><\/div>\n
          <\/code>description: OK<\/code><\/div>\n
          <\/code>content:<\/code><\/div>\n
            <\/code>application\/json:<\/code><\/div>\n
              <\/code>schema:<\/code><\/div>\n
                <\/code>$ref: <\/code>'#\/components\/schemas\/Greeting'<\/code><\/div>\n
    <\/code>post:<\/code><\/div>\n
      <\/code>tags:<\/code><\/div>\n
      <\/code>- JAX-RS Resource<\/code><\/div>\n
      <\/code>operationId: newHelloJaxRs<\/code><\/div>\n
      <\/code>requestBody:<\/code><\/div>\n
        <\/code>content:<\/code><\/div>\n
          <\/code>application\/json:<\/code><\/div>\n
            <\/code>schema:<\/code><\/div>\n
              <\/code>$ref: <\/code>'#\/components\/schemas\/Greeting'<\/code><\/div>\n
      <\/code>responses:<\/code><\/div>\n
        <\/code>\"200\"<\/code>:<\/code><\/div>\n
          <\/code>description: OK<\/code><\/div>\n
          <\/code>content:<\/code><\/div>\n
            <\/code>application\/json:<\/code><\/div>\n
              <\/code>schema:<\/code><\/div>\n
                <\/code>$ref: <\/code>'#\/components\/schemas\/Greeting'<\/code><\/div>\n
  <\/code>\/jax-rs\/hello\/{message}:<\/code><\/div>\n
    <\/code>delete:<\/code><\/div>\n
      <\/code>tags:<\/code><\/div>\n
      <\/code>- JAX-RS Resource<\/code><\/div>\n
      <\/code>operationId: deleteHelloJaxRs<\/code><\/div>\n
      <\/code>parameters:<\/code><\/div>\n
      <\/code>- name: message<\/code><\/div>\n
        <\/code>in: path<\/code><\/div>\n
        <\/code>required: <\/code>true<\/code><\/div>\n
        <\/code>schema:<\/code><\/div>\n
          <\/code>type: string<\/code><\/div>\n
      <\/code>responses:<\/code><\/div>\n
        <\/code>\"204\"<\/code>:<\/code><\/div>\n
          <\/code>description: No Content<\/code><\/div>\n
  <\/code>\/spring\/hello:<\/code><\/div>\n
    <\/code>get:<\/code><\/div>\n
      <\/code>tags:<\/code><\/div>\n
      <\/code>- Spring Resource<\/code><\/div>\n
      <\/code>operationId: helloSpring<\/code><\/div>\n
      <\/code>responses:<\/code><\/div>\n
        <\/code>\"200\"<\/code>:<\/code><\/div>\n
          <\/code>description: OK<\/code><\/div>\n
          <\/code>content:<\/code><\/div>\n
            <\/code>application\/json:<\/code><\/div>\n
              <\/code>schema:<\/code><\/div>\n
                <\/code>$ref: <\/code>'#\/components\/schemas\/Greeting'<\/code><\/div>\n
    <\/code>post:<\/code><\/div>\n
      <\/code>tags:<\/code><\/div>\n
      <\/code>- Spring Resource<\/code><\/div>\n
      <\/code>operationId: newHelloSpring<\/code><\/div>\n
      <\/code>requestBody:<\/code><\/div>\n
        <\/code>content:<\/code><\/div>\n
          <\/code>'*\/*'<\/code>:<\/code><\/div>\n
            <\/code>schema:<\/code><\/div>\n
              <\/code>$ref: <\/code>'#\/components\/schemas\/Greeting'<\/code><\/div>\n
      <\/code>responses:<\/code><\/div>\n
        <\/code>\"200\"<\/code>:<\/code><\/div>\n
          <\/code>description: OK<\/code><\/div>\n
          <\/code>content:<\/code><\/div>\n
            <\/code>application\/json:<\/code><\/div>\n
              <\/code>schema:<\/code><\/div>\n
                <\/code>$ref: <\/code>'#\/components\/schemas\/Greeting'<\/code><\/div>\n
  <\/code>\/spring\/hello\/{message}:<\/code><\/div>\n
    <\/code>delete:<\/code><\/div>\n
      <\/code>tags:<\/code><\/div>\n
      <\/code>- Spring Resource<\/code><\/div>\n
      <\/code>operationId: deleteHelloSpring<\/code><\/div>\n
      <\/code>parameters:<\/code><\/div>\n
      <\/code>- name: message<\/code><\/div>\n
        <\/code>in: path<\/code><\/div>\n
        <\/code>required: <\/code>true<\/code><\/div>\n
        <\/code>schema:<\/code><\/div>\n
          <\/code>type: string<\/code><\/div>\n
      <\/code>responses:<\/code><\/div>\n
        <\/code>\"204\"<\/code>:<\/code><\/div>\n
          <\/code>description: No Content<\/code><\/div>\n
  <\/code>\/vertx\/hello:<\/code><\/div>\n
    <\/code>get:<\/code><\/div>\n
      <\/code>tags:<\/code><\/div>\n
      <\/code>- Vert.x Resource<\/code><\/div>\n
      <\/code>operationId: helloVertX<\/code><\/div>\n
      <\/code>responses:<\/code><\/div>\n
        <\/code>\"200\"<\/code>:<\/code><\/div>\n
          <\/code>description: OK<\/code><\/div>\n
          <\/code>content:<\/code><\/div>\n
            <\/code>application\/json:<\/code><\/div>\n
              <\/code>schema:<\/code><\/div>\n
                <\/code>$ref: <\/code>'#\/components\/schemas\/Greeting'<\/code><\/div>\n
    <\/code>post:<\/code><\/div>\n
      <\/code>tags:<\/code><\/div>\n
      <\/code>- Vert.x Resource<\/code><\/div>\n
      <\/code>operationId: newHelloVertX<\/code><\/div>\n
      <\/code>requestBody:<\/code><\/div>\n
        <\/code>content:<\/code><\/div>\n
          <\/code>'*\/*'<\/code>:<\/code><\/div>\n
            <\/code>schema:<\/code><\/div>\n
              <\/code>$ref: <\/code>'#\/components\/schemas\/Greeting'<\/code><\/div>\n
      <\/code>responses:<\/code><\/div>\n
        <\/code>\"200\"<\/code>:<\/code><\/div>\n
          <\/code>description: OK<\/code><\/div>\n
          <\/code>content:<\/code><\/div>\n
            <\/code>application\/json:<\/code><\/div>\n
              <\/code>schema:<\/code><\/div>\n
                <\/code>$ref: <\/code>'#\/components\/schemas\/Greeting'<\/code><\/div>\n
  <\/code>\/vertx\/hello\/{message}:<\/code><\/div>\n
    <\/code>delete:<\/code><\/div>\n
      <\/code>tags:<\/code><\/div>\n
      <\/code>- Vert.x Resource<\/code><\/div>\n
      <\/code>operationId: deleteHelloVertX<\/code><\/div>\n
      <\/code>parameters:<\/code><\/div>\n
      <\/code>- name: message<\/code><\/div>\n
        <\/code>in: path<\/code><\/div>\n
        <\/code>required: <\/code>true<\/code><\/div>\n
        <\/code>schema:<\/code><\/div>\n
          <\/code>type: string<\/code><\/div>\n
      <\/code>responses:<\/code><\/div>\n
        <\/code>\"204\"<\/code>:<\/code><\/div>\n
          <\/code>description: No Content<\/code><\/div>\n
components:<\/code><\/div>\n
  <\/code>schemas:<\/code><\/div>\n
    <\/code>Greeting:<\/code><\/div>\n
      <\/code>type: object<\/code><\/div>\n
      <\/code>properties:<\/code><\/div>\n
        <\/code>message:<\/code><\/div>\n
          <\/code>type: string<\/code><\/div>\n
        <\/code>to:<\/code><\/div>\n
          <\/code>type: string<\/code><\/div>\n<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<\/div>\n

This contains resources from JAX-RS, Spring Web, Vert.x Reactive Routes and Servlet.<\/p>\n

Swagger UI<\/h2>\n

In Quarkus, Swagger-UI is included by default and when you now browse to localhost:8080\/swagger-ui<\/a> you will see the UI with all your endpoints:<\/p>\n

\n
\"\"<\/figure>\n<\/div>\n

Summary<\/h2>\n

In this post we looked at how Quarkus extends the MicroProfile OpenAPI specification to make it even easier to document your Endpoints. We also looked at how you can document any web framework using it.<\/p>\n

If you find any issues or have any suggestions, head over to the SmallRye<\/a> project and let\u2019s discuss it there.<\/p>\n

\n\n\n\n
\n

Published on Java Code Geeks with permission by Phillip Kr\u00fcger, partner at our JCG program<\/a>. See the original article here: MicroProfile OpenAPI for everyone<\/a><\/p>\n

Opinions expressed by Java Code Geeks contributors are their own.<\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n","protected":false},"excerpt":{"rendered":"

MicroProfile OpenAPI is primarily used for adding OpenAPI to JAX-RS Endpoints. In this blog post we will look at how the SmallRye Implementation extends this with some extra features, and support for more web frameworks, when used in Quarkus. Using Quarkus The example code is available here. You can also initialize a project using code.quarkus.io …<\/p>\n","protected":false},"author":10628,"featured_media":112,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[8],"tags":[1731,1975],"class_list":["post-106513","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-enterprise-java","tag-microprofile","tag-quarkus"],"yoast_head":"\nMicroProfile OpenAPI for everyone - Java Code Geeks<\/title>\n<meta name=\"description\" content=\"Interested to learn about MicroProfile OpenAPI? Check our article explaining how the SmallRye Implementation extends with some extra features.\" \/>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/www.javacodegeeks.com\/2020\/08\/microprofile-openapi-for-everyone.html\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"MicroProfile OpenAPI for everyone - Java Code Geeks\" \/>\n<meta property=\"og:description\" content=\"Interested to learn about MicroProfile OpenAPI? Check our article explaining how the SmallRye Implementation extends with some extra features.\" \/>\n<meta property=\"og:url\" content=\"https:\/\/www.javacodegeeks.com\/2020\/08\/microprofile-openapi-for-everyone.html\" \/>\n<meta property=\"og:site_name\" content=\"Java Code Geeks\" \/>\n<meta property=\"article:publisher\" content=\"https:\/\/www.facebook.com\/javacodegeeks\" \/>\n<meta property=\"article:published_time\" content=\"2020-08-26T07:00:57+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/www.javacodegeeks.com\/wp-content\/uploads\/2012\/10\/enterprise-java-logo.jpg\" \/>\n\t<meta property=\"og:image:width\" content=\"150\" \/>\n\t<meta property=\"og:image:height\" content=\"150\" \/>\n\t<meta property=\"og:image:type\" content=\"image\/jpeg\" \/>\n<meta name=\"author\" content=\"Phillip Kruger\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:creator\" content=\"@javacodegeeks\" \/>\n<meta name=\"twitter:site\" content=\"@javacodegeeks\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"Phillip Kruger\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"30 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\\\/\\\/schema.org\",\"@graph\":[{\"@type\":\"Article\",\"@id\":\"https:\\\/\\\/www.javacodegeeks.com\\\/2020\\\/08\\\/microprofile-openapi-for-everyone.html#article\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/www.javacodegeeks.com\\\/2020\\\/08\\\/microprofile-openapi-for-everyone.html\"},\"author\":{\"name\":\"Phillip Kruger\",\"@id\":\"https:\\\/\\\/www.javacodegeeks.com\\\/#\\\/schema\\\/person\\\/f24087666e9c716ac25d6c5aceff9a6a\"},\"headline\":\"MicroProfile OpenAPI for everyone\",\"datePublished\":\"2020-08-26T07:00:57+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\\\/\\\/www.javacodegeeks.com\\\/2020\\\/08\\\/microprofile-openapi-for-everyone.html\"},\"wordCount\":928,\"commentCount\":0,\"publisher\":{\"@id\":\"https:\\\/\\\/www.javacodegeeks.com\\\/#organization\"},\"image\":{\"@id\":\"https:\\\/\\\/www.javacodegeeks.com\\\/2020\\\/08\\\/microprofile-openapi-for-everyone.html#primaryimage\"},\"thumbnailUrl\":\"https:\\\/\\\/www.javacodegeeks.com\\\/wp-content\\\/uploads\\\/2012\\\/10\\\/enterprise-java-logo.jpg\",\"keywords\":[\"MicroProfile\",\"quarkus\"],\"articleSection\":[\"Enterprise Java\"],\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"CommentAction\",\"name\":\"Comment\",\"target\":[\"https:\\\/\\\/www.javacodegeeks.com\\\/2020\\\/08\\\/microprofile-openapi-for-everyone.html#respond\"]}]},{\"@type\":\"WebPage\",\"@id\":\"https:\\\/\\\/www.javacodegeeks.com\\\/2020\\\/08\\\/microprofile-openapi-for-everyone.html\",\"url\":\"https:\\\/\\\/www.javacodegeeks.com\\\/2020\\\/08\\\/microprofile-openapi-for-everyone.html\",\"name\":\"MicroProfile OpenAPI for everyone - Java Code Geeks\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/www.javacodegeeks.com\\\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\\\/\\\/www.javacodegeeks.com\\\/2020\\\/08\\\/microprofile-openapi-for-everyone.html#primaryimage\"},\"image\":{\"@id\":\"https:\\\/\\\/www.javacodegeeks.com\\\/2020\\\/08\\\/microprofile-openapi-for-everyone.html#primaryimage\"},\"thumbnailUrl\":\"https:\\\/\\\/www.javacodegeeks.com\\\/wp-content\\\/uploads\\\/2012\\\/10\\\/enterprise-java-logo.jpg\",\"datePublished\":\"2020-08-26T07:00:57+00:00\",\"description\":\"Interested to learn about MicroProfile OpenAPI? Check our article explaining how the SmallRye Implementation extends with some extra features.\",\"breadcrumb\":{\"@id\":\"https:\\\/\\\/www.javacodegeeks.com\\\/2020\\\/08\\\/microprofile-openapi-for-everyone.html#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\\\/\\\/www.javacodegeeks.com\\\/2020\\\/08\\\/microprofile-openapi-for-everyone.html\"]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\\\/\\\/www.javacodegeeks.com\\\/2020\\\/08\\\/microprofile-openapi-for-everyone.html#primaryimage\",\"url\":\"https:\\\/\\\/www.javacodegeeks.com\\\/wp-content\\\/uploads\\\/2012\\\/10\\\/enterprise-java-logo.jpg\",\"contentUrl\":\"https:\\\/\\\/www.javacodegeeks.com\\\/wp-content\\\/uploads\\\/2012\\\/10\\\/enterprise-java-logo.jpg\",\"width\":150,\"height\":150,\"caption\":\"java-interview-questions-answers\"},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\\\/\\\/www.javacodegeeks.com\\\/2020\\\/08\\\/microprofile-openapi-for-everyone.html#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\\\/\\\/www.javacodegeeks.com\\\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Java\",\"item\":\"https:\\\/\\\/www.javacodegeeks.com\\\/category\\\/java\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Enterprise Java\",\"item\":\"https:\\\/\\\/www.javacodegeeks.com\\\/category\\\/java\\\/enterprise-java\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"MicroProfile OpenAPI for everyone\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\\\/\\\/www.javacodegeeks.com\\\/#website\",\"url\":\"https:\\\/\\\/www.javacodegeeks.com\\\/\",\"name\":\"Java Code Geeks\",\"description\":\"Java Developers Resource Center\",\"publisher\":{\"@id\":\"https:\\\/\\\/www.javacodegeeks.com\\\/#organization\"},\"alternateName\":\"JCG\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\\\/\\\/www.javacodegeeks.com\\\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\\\/\\\/www.javacodegeeks.com\\\/#organization\",\"name\":\"Exelixis Media P.C.\",\"url\":\"https:\\\/\\\/www.javacodegeeks.com\\\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\\\/\\\/www.javacodegeeks.com\\\/#\\\/schema\\\/logo\\\/image\\\/\",\"url\":\"https:\\\/\\\/www.javacodegeeks.com\\\/wp-content\\\/uploads\\\/2022\\\/06\\\/exelixis-logo.png\",\"contentUrl\":\"https:\\\/\\\/www.javacodegeeks.com\\\/wp-content\\\/uploads\\\/2022\\\/06\\\/exelixis-logo.png\",\"width\":864,\"height\":246,\"caption\":\"Exelixis Media P.C.\"},\"image\":{\"@id\":\"https:\\\/\\\/www.javacodegeeks.com\\\/#\\\/schema\\\/logo\\\/image\\\/\"},\"sameAs\":[\"https:\\\/\\\/www.facebook.com\\\/javacodegeeks\",\"https:\\\/\\\/x.com\\\/javacodegeeks\"]},{\"@type\":\"Person\",\"@id\":\"https:\\\/\\\/www.javacodegeeks.com\\\/#\\\/schema\\\/person\\\/f24087666e9c716ac25d6c5aceff9a6a\",\"name\":\"Phillip Kruger\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\\\/\\\/secure.gravatar.com\\\/avatar\\\/38e989af8597679e556461deb73f4044c27d0228a28f9971d2ac37794b1b8603?s=96&d=mm&r=g\",\"url\":\"https:\\\/\\\/secure.gravatar.com\\\/avatar\\\/38e989af8597679e556461deb73f4044c27d0228a28f9971d2ac37794b1b8603?s=96&d=mm&r=g\",\"contentUrl\":\"https:\\\/\\\/secure.gravatar.com\\\/avatar\\\/38e989af8597679e556461deb73f4044c27d0228a28f9971d2ac37794b1b8603?s=96&d=mm&r=g\",\"caption\":\"Phillip Kruger\"},\"description\":\"Phillip is a software developer and a systems architect who knacks for solving problems. He has a passion for clean code and evolutionary architecture. He blogs about all technical things.\",\"sameAs\":[\"https:\\\/\\\/www.phillip-kruger.com\\\/\",\"https:\\\/\\\/www.linkedin.com\\\/in\\\/phillipkruger\\\/\"],\"url\":\"https:\\\/\\\/www.javacodegeeks.com\\\/author\\\/phillip-kruger\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"MicroProfile OpenAPI for everyone - Java Code Geeks","description":"Interested to learn about MicroProfile OpenAPI? Check our article explaining how the SmallRye Implementation extends with some extra features.","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/www.javacodegeeks.com\/2020\/08\/microprofile-openapi-for-everyone.html","og_locale":"en_US","og_type":"article","og_title":"MicroProfile OpenAPI for everyone - Java Code Geeks","og_description":"Interested to learn about MicroProfile OpenAPI? Check our article explaining how the SmallRye Implementation extends with some extra features.","og_url":"https:\/\/www.javacodegeeks.com\/2020\/08\/microprofile-openapi-for-everyone.html","og_site_name":"Java Code Geeks","article_publisher":"https:\/\/www.facebook.com\/javacodegeeks","article_published_time":"2020-08-26T07:00:57+00:00","og_image":[{"width":150,"height":150,"url":"https:\/\/www.javacodegeeks.com\/wp-content\/uploads\/2012\/10\/enterprise-java-logo.jpg","type":"image\/jpeg"}],"author":"Phillip Kruger","twitter_card":"summary_large_image","twitter_creator":"@javacodegeeks","twitter_site":"@javacodegeeks","twitter_misc":{"Written by":"Phillip Kruger","Est. reading time":"30 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/www.javacodegeeks.com\/2020\/08\/microprofile-openapi-for-everyone.html#article","isPartOf":{"@id":"https:\/\/www.javacodegeeks.com\/2020\/08\/microprofile-openapi-for-everyone.html"},"author":{"name":"Phillip Kruger","@id":"https:\/\/www.javacodegeeks.com\/#\/schema\/person\/f24087666e9c716ac25d6c5aceff9a6a"},"headline":"MicroProfile OpenAPI for everyone","datePublished":"2020-08-26T07:00:57+00:00","mainEntityOfPage":{"@id":"https:\/\/www.javacodegeeks.com\/2020\/08\/microprofile-openapi-for-everyone.html"},"wordCount":928,"commentCount":0,"publisher":{"@id":"https:\/\/www.javacodegeeks.com\/#organization"},"image":{"@id":"https:\/\/www.javacodegeeks.com\/2020\/08\/microprofile-openapi-for-everyone.html#primaryimage"},"thumbnailUrl":"https:\/\/www.javacodegeeks.com\/wp-content\/uploads\/2012\/10\/enterprise-java-logo.jpg","keywords":["MicroProfile","quarkus"],"articleSection":["Enterprise Java"],"inLanguage":"en-US","potentialAction":[{"@type":"CommentAction","name":"Comment","target":["https:\/\/www.javacodegeeks.com\/2020\/08\/microprofile-openapi-for-everyone.html#respond"]}]},{"@type":"WebPage","@id":"https:\/\/www.javacodegeeks.com\/2020\/08\/microprofile-openapi-for-everyone.html","url":"https:\/\/www.javacodegeeks.com\/2020\/08\/microprofile-openapi-for-everyone.html","name":"MicroProfile OpenAPI for everyone - Java Code Geeks","isPartOf":{"@id":"https:\/\/www.javacodegeeks.com\/#website"},"primaryImageOfPage":{"@id":"https:\/\/www.javacodegeeks.com\/2020\/08\/microprofile-openapi-for-everyone.html#primaryimage"},"image":{"@id":"https:\/\/www.javacodegeeks.com\/2020\/08\/microprofile-openapi-for-everyone.html#primaryimage"},"thumbnailUrl":"https:\/\/www.javacodegeeks.com\/wp-content\/uploads\/2012\/10\/enterprise-java-logo.jpg","datePublished":"2020-08-26T07:00:57+00:00","description":"Interested to learn about MicroProfile OpenAPI? Check our article explaining how the SmallRye Implementation extends with some extra features.","breadcrumb":{"@id":"https:\/\/www.javacodegeeks.com\/2020\/08\/microprofile-openapi-for-everyone.html#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/www.javacodegeeks.com\/2020\/08\/microprofile-openapi-for-everyone.html"]}]},{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/www.javacodegeeks.com\/2020\/08\/microprofile-openapi-for-everyone.html#primaryimage","url":"https:\/\/www.javacodegeeks.com\/wp-content\/uploads\/2012\/10\/enterprise-java-logo.jpg","contentUrl":"https:\/\/www.javacodegeeks.com\/wp-content\/uploads\/2012\/10\/enterprise-java-logo.jpg","width":150,"height":150,"caption":"java-interview-questions-answers"},{"@type":"BreadcrumbList","@id":"https:\/\/www.javacodegeeks.com\/2020\/08\/microprofile-openapi-for-everyone.html#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/www.javacodegeeks.com\/"},{"@type":"ListItem","position":2,"name":"Java","item":"https:\/\/www.javacodegeeks.com\/category\/java"},{"@type":"ListItem","position":3,"name":"Enterprise Java","item":"https:\/\/www.javacodegeeks.com\/category\/java\/enterprise-java"},{"@type":"ListItem","position":4,"name":"MicroProfile OpenAPI for everyone"}]},{"@type":"WebSite","@id":"https:\/\/www.javacodegeeks.com\/#website","url":"https:\/\/www.javacodegeeks.com\/","name":"Java Code Geeks","description":"Java Developers Resource Center","publisher":{"@id":"https:\/\/www.javacodegeeks.com\/#organization"},"alternateName":"JCG","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/www.javacodegeeks.com\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/www.javacodegeeks.com\/#organization","name":"Exelixis Media P.C.","url":"https:\/\/www.javacodegeeks.com\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/www.javacodegeeks.com\/#\/schema\/logo\/image\/","url":"https:\/\/www.javacodegeeks.com\/wp-content\/uploads\/2022\/06\/exelixis-logo.png","contentUrl":"https:\/\/www.javacodegeeks.com\/wp-content\/uploads\/2022\/06\/exelixis-logo.png","width":864,"height":246,"caption":"Exelixis Media P.C."},"image":{"@id":"https:\/\/www.javacodegeeks.com\/#\/schema\/logo\/image\/"},"sameAs":["https:\/\/www.facebook.com\/javacodegeeks","https:\/\/x.com\/javacodegeeks"]},{"@type":"Person","@id":"https:\/\/www.javacodegeeks.com\/#\/schema\/person\/f24087666e9c716ac25d6c5aceff9a6a","name":"Phillip Kruger","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/secure.gravatar.com\/avatar\/38e989af8597679e556461deb73f4044c27d0228a28f9971d2ac37794b1b8603?s=96&d=mm&r=g","url":"https:\/\/secure.gravatar.com\/avatar\/38e989af8597679e556461deb73f4044c27d0228a28f9971d2ac37794b1b8603?s=96&d=mm&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/38e989af8597679e556461deb73f4044c27d0228a28f9971d2ac37794b1b8603?s=96&d=mm&r=g","caption":"Phillip Kruger"},"description":"Phillip is a software developer and a systems architect who knacks for solving problems. He has a passion for clean code and evolutionary architecture. He blogs about all technical things.","sameAs":["https:\/\/www.phillip-kruger.com\/","https:\/\/www.linkedin.com\/in\/phillipkruger\/"],"url":"https:\/\/www.javacodegeeks.com\/author\/phillip-kruger"}]}},"_links":{"self":[{"href":"https:\/\/www.javacodegeeks.com\/wp-json\/wp\/v2\/posts\/106513","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.javacodegeeks.com\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.javacodegeeks.com\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.javacodegeeks.com\/wp-json\/wp\/v2\/users\/10628"}],"replies":[{"embeddable":true,"href":"https:\/\/www.javacodegeeks.com\/wp-json\/wp\/v2\/comments?post=106513"}],"version-history":[{"count":0,"href":"https:\/\/www.javacodegeeks.com\/wp-json\/wp\/v2\/posts\/106513\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/www.javacodegeeks.com\/wp-json\/wp\/v2\/media\/112"}],"wp:attachment":[{"href":"https:\/\/www.javacodegeeks.com\/wp-json\/wp\/v2\/media?parent=106513"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.javacodegeeks.com\/wp-json\/wp\/v2\/categories?post=106513"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.javacodegeeks.com\/wp-json\/wp\/v2\/tags?post=106513"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}