Maven Generate OpenAPI JSON for SpringBoot REST Controllers

Question

Is there a Maven plugin which can generate an openapi.json file at build time for my SpringBoot RestControllers?

If not a Maven plugin, is there another simple package to generate the file at build time?

I only want the openapi.json file, I don't want Swagger UIs auto-integrated, etc.

carlosvin.github.io/es/posts/creating-custom-maven-plugin

Jonathan JOhx
– Jonathan JOhx

2020-01-06 17:53:00 +00:00
Commented Jan 6, 2020 at 17:53 — Jonathan JOhx
– Jonathan JOhx, Commented Jan 6, 2020 at 17:53

KevinB · Accepted Answer · 2020-01-07 14:27:33Z

1

I was able to get this working with SpringDoc.

I couldn't find a project which showed exactly my use-case (without all the swagger ui stuff), so I created an example project on GitHub for others to use as reference: springdoc-maven-plugin-demo

answered Jan 7, 2020 at 14:27

KevinB

1,2122 gold badges10 silver badges20 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

Balazs Kelemen Over a year ago

This means we must start our whole SpringBoot web application in order to extract the API doc from it. :( I don't really like this solution.

NullPointerException · Accepted Answer · 2020-01-06 18:28:44Z

0

You can use Spring-doc which support OpenAPI 3

Look at the demos

answered Jan 6, 2020 at 18:28

NullPointerException

3,8245 gold badges32 silver badges62 bronze badges

1 Comment

KevinB Over a year ago

Is there a project in that repo that demonstrates building the openapi.json file via Maven? I couldn't find it.

Collectives™ on Stack Overflow

Maven Generate OpenAPI JSON for SpringBoot REST Controllers

2 Answers 2

1 Comment

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

1 Comment

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related