Global Directory
Global Directory
EXPLORE OUR SITES
London Stock Exchange Group
LSEG Data & Analytics
MyAccount
LSEG Perspectives
London Stock Exchange
FTSE Russell
LCH
Contact Us
Home
TR Internal
Which is the tool used to generate REST API documentation ?
Enrique Molinari
I wonder if the documentation I found here:
http://foldering.int.next.ci.westlaw.com/Foldering/API/indexByFeature.html
was generated by a tool and which is this tool.
Find more posts tagged with
refinitiv-internal
Accepted answers
matt.dimich
We generate this documentation every build. We created a custom ant task that essentially scans our controllers and gathers the JavaDoc information from our endpoints to dynamically create our endpoint documentation. I'm not sure how reusable it is at this point, but if you have access to the tfsnpt instance of TFS, you can find the code here:
$/Cobalt Foldering/Development/FolderingAntTasks
If not, respond to this post and I'll see what I can do to get it added as a project on The Hub that everyone could use.
Matt
All comments
matt.dimich
We generate this documentation every build. We created a custom ant task that essentially scans our controllers and gathers the JavaDoc information from our endpoints to dynamically create our endpoint documentation. I'm not sure how reusable it is at this point, but if you have access to the tfsnpt instance of TFS, you can find the code here:
$/Cobalt Foldering/Development/FolderingAntTasks
If not, respond to this post and I'll see what I can do to get it added as a project on The Hub that everyone could use.
Matt
Ryan Morlok
Or on component marketplace
Ryan Morlok
Here is another tool to document REST apis. I've never used it personally, and I'm not aware of it being used within the company:
http://swagger.wordnik.com/
Enrique Molinari
Many Thanks. I will see if I can get read-only permissions to TFS to look into the code of the Ant task. If not I will get back to this post
Enrique Molinari
Many Thanks. I will have a look.
Quick Links
All Forums
Recent Questions
Terms of use
Privacy & Cookie Statement
Cookies settings
Do not sell my info
Whistleblowing
UK Bribery Act
Modern Slavery Act