Tobias KopelkeTobias Kopelke

My feedback

  1. 133 votes
    Vote
    Sign in
    Check!
    (thinking…)
    Reset
    or sign in with
    • facebook
    • google
      Password icon
      I agree to the terms of service
      Signed in as (Sign out)
      You have left! (?) (thinking…)
      14 comments  ·  General  ·  Admin →
      started  ·  ZZ responded

      Updated information.

      You can already describe URI parameters in structured way with the new API Blueprint format. Refer to https://github.com/apiaryio/api-blueprint/blob/master/examples/7.%20Parameters.md for details.

      The new format is now default and URI parameters are properly rendered in the documentation.


      We are still working on description of http message–body properties (parameters). It is planned in the upcoming revision 1B of API Blueprint – as discussed in https://github.com/apiaryio/api-blueprint/issues/25

      Tobias KopelkeTobias Kopelke commented  · 

      I'm not sure how to have optional static parts in my url
      These should work and return the same resource, just differently formatted:
      GET /service/{id}
      GET /service/{id}.{format}

      I'd write it like this
      GET /service/{id}[.{format}]
      in apiary I could write it like this-ish:
      GET /service/{id}.{?format}

      or do I need to create to API descriptions for the same resource?

    Feedback and Knowledge Base