Child pages
  • API Descripter Preview
Skip to end of metadata
Go to start of metadata

Session led by Travis Haagen.


  • ForgeRock's Common REST, or CREST, uses a lot of the ideas from REST over http, but is not tied to http.
  • Use Cases for the API Descriptor:
    • Short term: generate HTML docs from code; experiment with API endpoints
    • Long term: generate client libraries; document scripted API endpoints; build UI dynamically
  • Version 1.0 just completed, and we will now integrate the work into the different products (reminder of 2016).
  • Once integrated into products,  the descriptions will be dynamic, per product instance. 
    • --> For example: it’s not THE OpenIDM API documentation, but it’s YOUR OpenIDM API documentation!
  • Comment from attendee:  Being able to dynamically discover all APIs is definitely key!
  • The ForgeRock API Descriptor specification, configuration artifacts and annotations make up the API Model.
    • From the API model, swagger (OpenAPI) JSON is generated, dynamically displayed in a swagger-like UI: intended for a good, dynamic overview and entry point for APIs.
      • --> This will reflect only the APIs that are actually configured.
    • From the API model, Asciidocs are generated, and eventually transformed into HTML documentation: for very detailed, complete API documentation.
      • --> This documentation can cover APIs that could be configured, even if the admin has not chosen to configure them yet for a particular server.


  • No labels