Stack Overflow
Stack Overflow

Questions tagged [apiary.io]

Next generation platform for building and using REST APIs.

162 questions
2
votes
1 answer

Apiary.io different responses without depending on status codes

I was trying to create an API mock using apiary.io. A section of my current API blueprint looks like follows. + Request (application/json) { "key": "secret", } + Response 200 (application/json) { "decision_type" : 1, …
Philip John
  • 5,275
  • 10
  • 43
  • 68
2
votes
1 answer

Omit property of object defined in MSON

How can I ommit property from defined MSON? I have defined one simple entity (object) using MSON: # Data Structures ## Article (object) Represents an article ## Properties + id: 1 (number, optional) + name: My first article (string) ## Articles…
Northys
  • 1,305
  • 3
  • 16
  • 32
2
votes
1 answer

Apiary.io, same route different method

I'm trying to define a simple CRUD routes in Apiary.io but the interactive editor is complaining because some of my routes are called the same: /questions/{question_id} (GET) /questions/{question_id} (PUT) "The resource '/questions/{question_id}'…
fguillen
  • 36,125
  • 23
  • 149
  • 210
2
votes
1 answer

More [GET] request-response examples with different URI parameters

I have an URI: /lessons/{language}/{type} I would like to have more mock requests-responses with different parameters {language} and {type} in my blueprint. It seems to me that this is not possible for GET method. My idea is that: GET…
Jirik
  • 1,435
  • 11
  • 18
2
votes
2 answers

Nested array with object in MSON is empty in Apiary.io documentation

I would like to create a nested array with objects in MSON format to use with API Blueprint and Apiary. I code looks correct but when I render it in Apiary I don't get the expected JSON. Example I want to create: A navigation has multiple…
JeroenVdb
  • 798
  • 1
  • 12
  • 21
2
votes
1 answer

Apiary Proxy Request Timed Out

I'm trying to use Apiary to document my API and test requests but I keep getting a response 504 Proxy Request Timed Out. My API is running on my machine under http://localhost:3000/ and I specified that under the HOST metadata. When I click…
WorkForPizza
  • 85
  • 7
2
votes
1 answer

How to add API version to Apiary Mock Server

Is there any way to add API version to Apiary Mock Server? Ex.: http://private-XXXXX-apiname.apiary-mock.com/v1/mocks/1?school_id=1
joaofraga
  • 608
  • 7
  • 17
2
votes
2 answers

How to model different requests to same resource in api-blueprint/apiary

I'm writing some API definitions with apiary/api blueprint. Is there a way that, for the same resource, I can use the mock endpoint to behave differently depending on input (or failing that, some kind of work around)? For example, say I have an…
user384842
  • 1,946
  • 3
  • 17
  • 24
2
votes
1 answer

Create Mock Service API using Apiary

I'm attempting to create mock api services for testing purposes. We are already using Apiary on another team so I'm starting there. So far, I've noticed that if I want to have two separate calls requires mocking out of both requests. For example to…
user919388347489103
  • 21
  • 3
2
votes
1 answer

Sending POST parameters from apiary

I have created a REST API using Django. I'm making a POST request with some parameters user_id="5453ab249b0dbb3b76000009" user_type="instrcutor" In apiary blueprint , i'm sending these as a part of request body like: + Request…
navyad
  • 3,752
  • 7
  • 47
  • 88
2
votes
1 answer

Different request on same action with parameters

I want to search (say) "accounts" based on "name" or "status". So I would like to have two actions : GET /persons/?q=name==Jea* GET /persons/?q=status==locked How can I document that ? I tried an Action with multiples transactions : ### GET…
gervais.b
  • 2,294
  • 2
  • 22
  • 46
2
votes
2 answers

How to specify Header attributes in apiary documentation

Starting with Apiary, I'm currently specifying the APIs for our project. I was able to define the definitions for the API and defining the parameters works great. Now I would like to add also the values passed in the HTTP Headers into my…
Mathias G.
  • 4,875
  • 3
  • 39
  • 60
2
votes
1 answer

Is it possible to specify parameters which go into the post body with blueprint?

I'd like to be able to document the parameters as if they were URL parameters, since I like how that bit of documentation renders a handy table. However, in my API, I would like those paremeters to plug into the JSON body rather than the URL. Is…
Eugene
  • 2,946
  • 2
  • 26
  • 30
2
votes
2 answers

Does Apiary.io throttle responses?

I have an angularjs app that calls a RESTful service at apiary.io Does apiary.io throttle responses and delay responses after a certain number have been received? If so what are the parameters?
Greg Pagendam-Turner
  • 2,356
  • 5
  • 32
  • 49
2
votes
1 answer

Apiary: Refer to multiple models in a body

It seems you can only refer to the model itself in an unmodified form from a payload/body section: # Item [/] + Model { "name" : "an item" } ## GET + Response 200 [Item][] Is there any way to return an array of the model or use the…
billc.cn
  • 7,187
  • 3
  • 39
  • 79
1 2 3
…
10 11