[allura:tickets] Ticket 6797 discussion

[Dave Brondsema <da...@brondsema.net>]

- **labels**: allura-api, asf --> allura-api, asf, sf-current
- **Comment**:

Looks like apihub.com has moved.  I set up RAML browse/try functionality using Anypoint from Mulesoft for another project.  Example: https://anypoint.mulesoft.com/apiplatform/sourceforge/#/portals/organizations/98f11a03-7ec0-4a34-b001-c1ca0e0c45b1/apis/13878/versions/14637/pages/16345  The site was a little confusing, you only need to use a little part of it to set up the RAML viewing.



---

** [tickets:#6797] Move API docs from sf.net wiki to Allura (with raml?)**

**Status:** open
**Milestone:** unreleased
**Labels:** allura-api asf sf-current 
**Created:** Fri Oct 25, 2013 04:23 PM UTC by Dave Brondsema
**Last Updated:** Thu Apr 23, 2015 06:35 PM UTC
**Owner:** nobody

Right now the allura API docs are at https://sourceforge.net/p/forge/documentation/Allura%20API/  They should be moved to Allura itself.

We should also consider writing the API docs with [RAML](http://raml.org/) which looks very nice to me.  Simple and readable, has composition for things like "pagination" which apply to multiple endpoints.  With RAML we could also show interactive documentation with "try it live" functionality at http://www.apihub.com/


---

Sent from forge-allura.apache.org because dev@allura.apache.org is subscribed to https://forge-allura.apache.org/p/allura/tickets/

To unsubscribe from further messages, a project admin can change settings at https://forge-allura.apache.org/p/allura/admin/tickets/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.