Stack Overflow
Stack Overflow

Questions tagged [apiary.io]

Next generation platform for building and using REST APIs.

158 questions
189
votes
6 answers

Adding headers when using httpClient.GetAsync

I'm implementing an API made by other colleagues with Apiary.io, in a Windows Store app project. They show this example of a method I have to implement: var baseAddress = new Uri("https://private-a8014-xxxxxx.apiary-mock.com/"); using (var…
Ric
  • 4,139
  • 4
  • 25
  • 59
37
votes
4 answers

Is it possible to center tables in a markdown file?

I have a table: | This | Is | A | Table | | :--- | -- | - | ----: | | foo | ba | r | elbaT | I'd like the table to display in the center of my Markdown file instead of left-aligned. I am not trying to align text, but the entire table…
Meredith
  • 2,617
  • 3
  • 26
  • 55
28
votes
1 answer

How do I document a multipart request with apiary?

I want to document a multipart request like the following: Content-Length: 477 Content-Type: multipart/form-data; boundary=---BOUNDARY -----BOUNDARY Content-Disposition: form-data; name="image[file]"; filename="image.jpg" Content-Type:…
terje
  • 3,566
  • 1
  • 26
  • 28
22
votes
2 answers

How can I have multiple responses from a single endpoint with different parameters?

We are looking at using the API Blueprint. There are cases where we would like one request to return a proper response and another request to return an 'error' response such as a 400 bad request so that other developers can work against the mock…
Mendhak
  • 7,168
  • 3
  • 46
  • 58
19
votes
1 answer

Markdown multiline code blocks in tables when rows have to be specified with one-liners

I have a table: | YAY! | TABLE | \^^/ | 1-liner JSON column! | | ---- | ----- | ---- | -------------------- | | That | has | JSON | `{a: 1, b: 2, c: 3}` | | Here | is | more | `{d: 4, e: 5, f: 6}` | Is there any way for me to insert in…
Meredith
  • 2,617
  • 3
  • 26
  • 55
16
votes
2 answers

Documenting query parameters with API Blueprint

I'm trying to document a query parameter in API Blueprint, but I'm not entirely sure if I have done it correctly. The resource looks like this: DELETE http://baasar.apiary-mock.com/user/{appId}/{userId} That request would deactivate the user while…
Sebastian Dahlgren
  • 915
  • 1
  • 10
  • 20
12
votes
1 answer

Trying to describe the request and response using Data Structures in API Blueprint

I'm trying to document an endpoint with API Blueprint, using the new Attributes and DataStructures sections of the spec. My request payload looks like this: { "url": "http://requestb.in/11v7i7e1", "active": true, "types": [ { …
Piotr Zurek
  • 2,583
  • 1
  • 23
  • 32
11
votes
1 answer

What is the correct format for denoting that an input parameter is a date/time in Apiary?

I am editing some Apiary documentation on a project I am working on, and need to denote that a parameter to one of my API calls is a datetime string. Apiary seems to be choking on the formatting of this parameter, so I'm wondering what the…
Chris
  • 3,693
  • 4
  • 21
  • 30
11
votes
2 answers

Apiary.io - multiple responses (200) with different parameters

I am trying to get different responses passing different parameters but something is not working. This is my API: ## Question [/questions/{question_id}] A Question object has the following attributes: + Parameters + question_id: `1` (number,…
MeV
  • 3,337
  • 8
  • 33
  • 74
9
votes
2 answers

How To Show Nested Attribute Definition In Apiary.io

I have a data structure defined as follows: # Data Structures ## PlayerRank (object) Represents the minimum amount of data the the client needs to send to give rank information about a particular Player in a particular Played Game. + playerId…
jakejgordon
  • 3,778
  • 6
  • 31
  • 43
9
votes
1 answer

Apiary multiple blueprint file into one api

Hi I am using Apiary to maintain a documentation for my REST API, as our code base is growing our API documentation is getting bigger and bigger. It is becoming very difficult to put all our API inside the single blueprint file, is there any way we…
Muhammad Raihan Muhaimin
  • 4,923
  • 7
  • 39
  • 61
9
votes
2 answers

How can I change the ownership of an API Doc in apiary.io?

What I want is change the main email associated with an API Doc, so when I share the doc with others people they see that new email and not the mine. That new email have an apiary.io, that is why I'm talking about ownership transferring.
user1785721
8
votes
2 answers

How to provide example value to a Response Body of content-type: text/html in Swagger (to test with dredd)

I have an API call which responds 200 OK and returns an HTML. I would like to add this to my API documentation (especially since i validate it using dredd and unless i provide it with the expected response body the test fails). How would i do this…
Shachar R
  • 261
  • 2
  • 7
8
votes
1 answer

Apiary: Export API as JSON, to generate client code

We all know that apiary rocks (or not.. I think it does), and I was wondering what would it take to take it a step further allow users to export a JSON description of the API? (So developers can script client code generation) This should…
Mazyod
  • 21,361
  • 9
  • 86
  • 147
8
votes
1 answer

how to format a POST request on apiary.io?

thanks for your time I have a POST request that I want to document in the blueprint apiary, the header is something like this: text/html _method:POST data[User][username]: data[User][password]: data[User][remember]:0 http://d.pr/i/uRFx I have…
lito
  • 2,792
  • 9
  • 40
  • 68
1
2 3
…
10 11