I suggest you ...

Where do I just ask a question? I'm not suggesting a feature.

I'm trying to document an API that contains lots of non-restful routes. Things like /api/some_custom_report which takes a number of parameters. I can't seem to guess my way how to do this in the editor - it wants a group and then http verb routes under it.

1 vote
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…)
    traitwisetraitwise shared this idea  ·   ·  Admin →

    2 comments

    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)
      Submitting...
      • ApiaryAdminApiary (Admin, apiary.io) commented  · 

        The best place to ask questions regarding API Blueprint is the [Stack Overflow](http://stackoverflow.com/questions/tagged/apiblueprint) - make sure you are using the [apiblueprint tag](http://stackoverflow.com/questions/tagged/apiblueprint). Alternatively you can always contact Apiary support either using the "intercom" built-in the Apiary web or sending an email to `support@apiary.io`.

        To answer your question – API Blueprint is Resource-oriented and as such it does not have any dedicated support for nesting URIs.

        You can, however specify various endpoints directly as long as their URI differ (e.g. `# GET /one/url` and `GET /some/other/url`).

      • traitwisetraitwise commented  · 

        Can't edit my post. To perhaps clarify, I'm talking about being able to document non-resourceful api routes. Or, being able to add a non-standard route under a given resource. For example, in your tutorial, you have the resource routes defined by ## Gist [/gists/{id}]. But what if you needed a non-standard route under this called at /gists/{id}/do_something_nonstandard?

      Feedback and Knowledge Base