This will identify this hidden (yet incredibly useful) capability. It prints out beautifully. (although the font size is a little large).1 vote
This is worked on as part of our documentation overhaul.
Provide a way to populate some parts of response with "variables".
* Provide "api base" that is corresponds to generated mock server URI
* Provide same variables that are specified in templated URI62 votes
Display warning if example JSON in request/response is not well-formed.32 votes
In editor, enable autosave option so I don't have to hit 'save' manually while editing.28 votes
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.40 votes
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
We plan to bootstrap community around blueprint tooling and framework bindings. Stay tuned!
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/send133 votes
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
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.
We would love to use apiary to create a fast mock for such service.20 votes
Often there are usecases for plain API documentation - FAQs, knowledge-base etc. Allow me to specify separate plain documentation pages.12 votes
This is planned with our new format overhaul.
Add the ability to include custom Google Analytics Profile tracking code on the API Documentation page.19 votes
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
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
We are working on http auth support as part of our blueprint overhaul.
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
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
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
We are working on the initial workflow support using git branches.
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
Orderly is easy to read-and-write replacement for JSON schema that can be compiled into it.2 votes
Well, the title says it all. Look at tumblr as an example.3 votes
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.
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
You can test your blueprints through our dredd testing tool: https://github.com/apiaryio/dredd
Apiary & Cucumber integration on its way.
- Don't see your idea?