Message Boards
Open API Profiles for Service Builder generated RESTful services
ANKIT SRIVASTAVA, modified 4 Years ago.
Open API Profiles for Service Builder generated RESTful services
Junior Member Posts: 76 Join Date: 2/2/11 Recent Posts
Hi All,
Do web services generated by the Service builder follow OpenAPI spec?
I can use RestBuilder to generate the services with OpenAPI spec but if I need to create a Restful service using Service builder for my custom entity, can I also get an Open API profile for the same or it's not supported due to Contract Last approach in SB.
Regards,
Ankit
Do web services generated by the Service builder follow OpenAPI spec?
I can use RestBuilder to generate the services with OpenAPI spec but if I need to create a Restful service using Service builder for my custom entity, can I also get an Open API profile for the same or it's not supported due to Contract Last approach in SB.
Regards,
Ankit
David H Nebinger, modified 4 Years ago.
RE: Open API Profiles for Service Builder generated RESTful services
Liferay Legend Posts: 14914 Join Date: 9/2/06 Recent Posts
No, they are seen as two different things.
SB represents your persistence layer. These should be organized under normalization principles (typically 3NF) to minimize storage requirements and maximize db performance.
However, the OpenAPI implementation is typically not going to be built around the same way you store the data. It's the big reason that there are two separate tools, so you get the chance to decouple how your data is stored from how it is best served from an API perspective.
SB represents your persistence layer. These should be organized under normalization principles (typically 3NF) to minimize storage requirements and maximize db performance.
However, the OpenAPI implementation is typically not going to be built around the same way you store the data. It's the big reason that there are two separate tools, so you get the chance to decouple how your data is stored from how it is best served from an API perspective.