REST API Documentation?

Eight Stars

REST API Documentation?

So I have deployed a REST service using OpenSource ESB for over a year. Without our company, a couple of other teams are willing to use that API. I am wondering what is the best way to generate some type of documentation of my current service endpoints, Automatically if possible and hosted along with the service? I dont know if that is possible...

Thanks

 

 

Thirteen Stars

Re: REST API Documentation?

with Open Source version - not a big choice

 

simple information about services:

host:port/services

information about specific service (also simple)

host:port/services/{service_URL}?_wadl


but You always could use one of the 3rd party tools
normally for testing API I use - SoapUI and Paw, we are share this project files internally

they allow export API to Swagger, then possible to edit swagger file with Swagger Editor and public

Screen Shot 2018-02-08 at 09.16.24.png


little tricky ... but work

Subscription version starting from 6.4 support swagger documentation

-----------

Tutorial

Introduction to Talend Open Studio for Data Integration.

Definitive Guide to Data Integration

Practical steps to developing your data integration strategy.

Definitive Guide to Data Quality

Create systems and workflow to manage clean data ingestion and data transformation.