blog documentation FAQ followers forum marketplace services youtube

solved Documenting API

The Jamroom Network » Forum » Proxima » Page » Documenting API
alt=
DannyA
@dannya
8 years ago
584 posts
Just curious if proxima used some framework? I am looking to create some collections and need to provide documentation for creating an app, authenticating, and listing all the calls that can be made. I want to let people register their own apps, and add/update/view data.

I know there are some api frameworks that also generate documenatation. Do we have any of that?
updated by @dannya: 06/15/17 03:37:31PM
paul
@paul
8 years ago
4,335 posts
Not sure if this answers your question directly, but Proxima is based on the Jamroom framework so our Docs module would work with it.
hth


--
Paul Asher - JR Developer and System Import Specialist
alt=
DannyA
@dannya
8 years ago
584 posts
Not exactly. If you look at an api builder like Apiary or swagger, it generates the documentation for you. I was hoping proxima was created in a similar manner so that when we created the collections, the documentation interface would be created for you. Also, from what I can see, the Docs module would be very limited for creating complete api documentation.

I wounder if you could build your own JR api with swagger instead of using proxima...
updated by @dannya: 03/11/17 07:31:32AM
brian
@brian
8 years ago
10,149 posts
Proxima is built using Jamroom. There's no documentation API at this time.

Sorry!


--
Brian Johnson
Founder and Lead Developer - Jamroom
https://www.jamroom.net

Tags