When we talk about Swagger we are referring to a framework used for designing, documenting and building REST APIs. OK, and what is this thing called Swagger? It is closely linked to the new JS frameworks which are flooding the modern Internet these days: such an accepted specification streamlines the development of the APIs that of late consume the applications developed on Angular, React or even MetalJS.

The appearance of JAX-RS in Liferay DXP is no accident.

This specification has several implementations including Apache CXF, which is what we will find in Liferay. JAX-RS is a JEE specification based on annotations such as: or which simplify REST API development.

In this article, we are going to convince you to take the plunge with this new technology, showing how its combination with Swagger and the OpenAPI specification can help us to quickly build robust REST API. The PA Team has been very helpful in my learning process but it has taken me a longer time than I first thought it would.With the arrival of Liferay DXP and JAX-RS services, we discovered a whole new world beyond JSON-WS and Service Builder. It seems to me, as a beginner, there is quite a bit to learn about Swagger and creating an API connection. The last one links to Swagger references in the last reply that might be of help. You might find it useful to learn from my mistakes in the following posts: one, two and this one. One you've validated the JSON and have it in Visual Studio (or maybe an online validator), save it as a .json file and use this to create the PA connection. I've found it very convenient to use Visual Studio to make any additional changes you need. (In VS, first create an empty JSON by clicking File, New, File, Web, C#, JSON file, then cut and paste the JSON from the converter). There are online validators you can use as well, such as this one or this one. You can then cut and paste the resulting JSON into Visual Studio to further validate the syntax of the JSON file. Once you have used the Swagger Editor to get a Swagger file with no errors, a path that exactly matches the path requirements of the API, and a response showing the data you want to retrieve (or post, etc), you can convert the file to JSON with online YAML-to-JSON converters like this one or this one.

Swagger editor json demo