General

I suggest you ...

You've used all your votes and won't be able to post a new idea, but you can still search and comment on existing ideas.

There are two ways to get more votes:

  • When an admin closes an idea you've voted on, you'll get your votes back from that idea.
  • You can remove your votes from an open idea you support.
  • To see ideas you have already voted on, select the "My feedback" filter and select "My open ideas".
(thinking…)

Enter your idea and we'll search to see if someone has already suggested it.

If a similar idea already exists, you can support and comment on it.

If it doesn't exist, you can post your idea so others can support it.

Enter your idea and we'll search to see if someone has already suggested it.

  1. add a print button next to the font size icon.

    This will identify this hidden (yet incredibly useful) capability. It prints out beautifully. (although the font size is a little large).

    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…)
    • Allow templating in responses

      Provide a way to populate some parts of response with "variables".

      Some ideas:

      * Provide "api base" that is corresponds to generated mock server URI
      * Provide same variables that are specified in templated URI

      62 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…)
        planned  ·  4 comments  ·  Admin →
      • JSON validation

        Display warning if example JSON in request/response is not well-formed.

        32 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…)
        • Autosave

          In editor, enable autosave option so I don't have to hit 'save' manually while editing.

          28 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…)
          • add JSON formatting.

            When entering JSON format data I take the junk spit out of my actual API implementation and enter in the blueprint. It's not normally pretty printed. You could use JSON Lint.

            https://github.com/zaach/jsonlint

            40 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…)
              planned  ·  4 comments  ·  Admin →
            • Add a possibility to generate full code template

              Well, I would love to describe API, have documentation and in one click get template with prepared methods and classes ready written in language of my choosing.

              Obviously this is not usable by some frameworks and/or programming languages, but I can imagine many developers would appreciate it.

              13 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…)
                planned  ·  Lukas LinhartLukas Linhart responded

                We plan to bootstrap community around blueprint tooling and framework bindings. Stay tuned!

              • Allow for elaboration of parameters in request/response

                The current system lets you simulate an API call, but sometimes a mock call won't explain everything. Some parameters in the call might be required while other things aren't; others might only be required when a different parameter is included; there could be an option with five different choices and another with a boolean and you could want to explain what all the options do.

                Thus I think there should be a place to describe the possible parameters and their options in the request and response, something like http://developers.dwolla.com/dev/docs/transactions/send

                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…)
                  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

                • Support for API with callbacks

                  We have an API that receives requests to initiate background jobs and as one parameter you get callback uri where you call the client with the result.

                  /api/do-long-job-and-let-me-know?callback=www.ourclient.com/api/...

                  We would love to use apiary to create a fast mock for such service.

                  20 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…)
                  • let me create generic (plain-form) help/documentation pages

                    Often there are usecases for plain API documentation - FAQs, knowledge-base etc. Allow me to specify separate plain documentation pages.

                    12 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…)
                    • Custom Google Analytics Profile For API Documentation

                      Add the ability to include custom Google Analytics Profile tracking code on the API Documentation page.

                      19 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…)
                        planned  ·  1 comment  ·  Admin →
                      • Support different scopes for API documentation

                        We use different oauth scopes to define access rights (and visibility) to our API resources, ranging from public to read to admin (for our internal access needs).

                        Ideally I would be able to render docs and filter based on scope, e.g. have a public documentation and one private for our api, but still using the same api docs.

                        6 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…)
                        • Support http authentication

                          Provide some way to indicate the required authentication (if any) for any given call. We use a combination of user credentials and api keys for our http basic auth, and would really like to see some way to support http authentication as part of the documentation and mockups. Also for Oauth scenarios perhaps?

                          248 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…)
                            started  ·  Lukas LinhartLukas Linhart responded

                            We are working on http auth support as part of our blueprint overhaul.

                          • allow using URL Template-matched parameters in response

                            In my resource returning 201 status, I'd like to do the proper thing and return a Location header. Is it possible to have the mock server generate a Location header from a URI template?

                            Having it be able to generate something shaped a certain way would be very cool.

                            6 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…)
                              under review  ·  1 comment  ·  Admin →
                            • Add support for CSON

                              CSON is alternative, coffee-script-inspired JSON notation.

                              It would be nice if one could write CSON in blueprint, but it would be transparently translated to JSON in responses.

                              3 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…)
                              • Support versioned documentation through git branches/tags

                                Developers who use a branching/tagging conventions in git (such as GitFlow: http://nvie.com/posts/a-successful-git-branching-model ) would appreciate this being reflected in apiary.

                                In this way the documentation for the current stable release of an api might be drawn from the repository's master branch, while previous versions would be available at tags, and ongoing work towards the next release could be viewed and discussed at a develop branch.

                                If the mock api were similarly configurable it'd be extra brilliant.

                                110 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…)
                                  started  ·  Lukas LinhartLukas Linhart responded

                                  We are working on the initial workflow support using git branches.

                                • URI Templates switch

                                  Hello. This is a minor proposal, but I found it good enough to bother you =)

                                  The URI Templates switch (and others too) may be improved with a color coding like in iOS. You may just set inner plate background to red (or grey when it's not destructive) when switch is off and green for "enabled" switch status.

                                  For me personally it will help to understand switch status more quickly. And all iOS users already know such pattern.

                                  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…)
                                    planned  ·  2 comments  ·  Admin →
                                  • support Orderly for JSON schema description

                                    Orderly is easy to read-and-write replacement for JSON schema that can be compiled into it.

                                    http://orderly-json.org/

                                    2 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…)
                                    • Allow us to use disqus for commenting.

                                      Well, the title says it all. Look at tumblr as an example.

                                      3 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…)
                                      • 75 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…)
                                          started  ·  Lukas LinhartLukas Linhart responded

                                          We have started to work on some OAuth2 support and testing it with some customers.

                                          Current status is “very alpha”; you can only mark the whole API as being authenticated and we do not provide any support for mock server yet.

                                        • Test suite from blueprint

                                          Provide a way to execute test suite.

                                          Test suite will go through defined resources execute according requests against given server. Results will be then compared with blueprint and pass/fail status will be shown.

                                          17 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…)
                                            1 comment  ·  Admin →
                                          • Don't see your idea?

                                          General

                                          Feedback and Knowledge Base