API Blueprint is a Markdown-based DSL for describing HTTP APIs.
API Blueprint is a Markdown-based DSL for describing HTTP APIs.
Documentation, opensourced parser and other utilities available at http://apiblueprint.org/
Questions tagged [apiblueprint]
250 questions
0
votes
3 answers
Java or JavaScript library to generate HTML from Swagger, RAML or API Blueprint
Problem:
I am searching for a library in Java or JavaScript (or maybe Scala) which is able to generate an HTML representation of Swagger, RAML or API Blueprint input.
Background:
The idea is to use it as a part of a (Play Framework) web app serving…
nize
- 1,012
- 1
- 11
- 27
0
votes
1 answer
Different versions of API Blueprint
The structure to the example on http://apiblueprint.org/#get-started seems to differ from the structure on APIary.io.
Can anyone please comment on whether they are different, and if so, which structure is correct?
For example,
API Blueprint Document…
MobiCycle Ltd
- 329
- 1
- 9
0
votes
1 answer
How to add value description with API Blueprint?
Is there any way to add a description to possible values of URI parameter?
## Search Items [/items{?s}]
### Get items [GET]
+ Parameters
+ s (optional, values) ... Sort results by
+ Values
+ `1 - price`
+ `4 -…
LA_
- 19,823
- 58
- 172
- 308
0
votes
1 answer
Given an API blueprint resource model, how can I ensure that the readonly part of a resource is not updatable?
I have a large model which I am using for both GET and PUT on a resource.
The model includes an "audit" object like so:
"audit": {
"createdAt": "2014-04-14T02:15:15Z",
"lastUpdatedAt":…
Justin
- 227
- 2
- 8
0
votes
1 answer
Can sole resources be added to the table of contents?
This
FORMAT: 1A
HOST: something.com
# Something API
# Group Something
Foobar description
## Some Route [/routeroute]
Foobar description
### Some HTML Action [GET]
+ Response 200 (text/plain)
# Group Something 2
Foobar description…
Meredith
- 3,928
- 4
- 33
- 58
0
votes
1 answer
API Blueprint parameter name not displaying
I am new to API Blueprint so please excuse my naivety here. I am trying to format some parameters such as given in the Aglio example:
+ Parameters
+ name (optional, string, `alice`) ... Search for a user by name
+ joinedBefore (optional,…
Nathaniel Wendt
- 1,194
- 4
- 23
- 49
0
votes
1 answer
JSON-RPC with apiblueprint
Apiary provides a clean interface for declaring URI parameters allowing for easy experimentation via thier console with a nice fill in the blank interface.
Is this possible to do for json-rpc or any http body parameter? If not, this would be…
Rob Rodriguez
- 403
- 4
- 9
0
votes
1 answer
Multiple authentication methods for Apiary
I'm just getting started with Apiary and I can't tell if this is a limitation of the product or just me not understanding what to do.
I'm documenting an API which authenticates the user as part of every request. Sometimes the authentication is part…
JMRboosties
- 15,500
- 20
- 76
- 116
-1
votes
1 answer
Data structure with string only
I'm trying to create a Data Structure
# Data Structures
## Incorrect Credentials (string)
- `Insufficient privileges.`
This is where it will be used:
+ Response 401 (application/vnd.api+json)
Not allowed.
+ Attributes (object)
…
basickarl
- 37,187
- 64
- 214
- 335
-1
votes
1 answer
what is difference between spring & blueprint & router in apache camel?
I am new in Fuse. I am using Jboss Fuse and creating Fuse project.
I want to know basic difference between container like spring, blueprint and router?
kamesh
- 41
- 7