Stack Overflow
Stack Overflow

Questions tagged [iodocs]

I/O Docs is a live interactive documentation system for RESTful web APIs. By defining APIs at the resource, method and parameter levels in a JSON schema, I/O Docs will generate a JavaScript client interface. API calls can be executed from this interface, which are then proxied through the I/O Docs server with payload data cleanly formatted (pretty-printed if JSON or XML).

https://github.com/mashery/iodocs

15 questions
8
votes
1 answer

Need to create an api doc for an existing application written with nodejs/express

I have a few private apis written in plain old express. Time to let it out and provide some api documentation. What I don't want (at least yet) it to re-write my express app to integrate api documentation into the code. Mainly since I am not sure…
lostintranslation
  • 23,756
  • 50
  • 159
  • 262
3
votes
2 answers

Convert swagger json to mashery io-docs json

Does anyone know about the existence of a JSON-сonverter from Swagger API Docs to Mashery I/O Docs?
samsonych
  • 51
  • 3
2
votes
1 answer

install iodocs on linux

I had this problem initially, so I tried npm install --force It seems to work, with only one warning: npm WARN querystring@0.0.1 package.json: bugs['web'] should probably be bugs['url'] But when I try to run it, it gives…
Mzq
  • 1,796
  • 4
  • 30
  • 65
2
votes
2 answers

django tastypie support for mashery iodocs?

Mashery iodocs is a tool for documenting API. It needs two configuration json objects to run. It would be nice to have this objects generated automatically by tastypie. Tastypie can generate json with schema, however it's incompatible with iodocs…
mnowotka
  • 16,430
  • 18
  • 88
  • 134
1
vote
0 answers

IODocs : First Object inside Array Doesn't have a tag name

I want to add a objects inside a array. I have to set a name for that object like "identifiers": [ "IDENTIFIER": { "primary": true } ] Here "IDENTIFIER" is the object name. But the first object inside array always…
Raja
  • 239
  • 1
  • 5
  • 18
1
vote
0 answers

IODocs - Passing cookie between API calls

I have a REST website built with flask, and use its session cookie features to keep a very basic 'login' (I don't require security). I'm trying to implement iodocs documentation. The "/login" works fine, and I also see the response with the cookie…
barakuda
  • 23
  • 4
1
vote
1 answer

Document private web API

We set up a web API for project internal usage. I'm looking for a nice way to document our API. I've searched the web and found IO Docs Swagger These tools read in JSON files that can be created automatically, e.g. for Java. Our API has grown and…
Norbert
  • 4,239
  • 7
  • 37
  • 59
1
vote
1 answer

no response using iodocs

HI I have deployed the iodocs locally,and its working for the samples given. but for my api its giving empty response. here is what i appended to /data/apiconfig.json "cloudspokes": { "name": "cloudspokes", "protocol": "http", "baseURL":…
vishesh
  • 2,007
  • 6
  • 32
  • 67
0
votes
4 answers

node.js and Redis on Heroku for IODocs

I'm trying to get IODocs running on Heroku. It requires node.js and Redis. Admittedly, I'm new to all of these technologies. Nonetheless, I've managed to get it running locally. However, I receive the following error when deploying to…
Jason McCreary
  • 71,546
  • 23
  • 135
  • 174
0
votes
0 answers

Mashery Interactive form is not recognizing my array parameter in the query section, how do I solve this?

I am using Tibco Mashery and passing a parameter of array type. When I define the parameter in Body of Request using io-Doc, Mashery Interactive form shows "Add item" option and let me enter items of the array one by one. But when I use the same…
leila jamee
  • 1
0
votes
2 answers

Array of objects using IODOCS

I want to add a Array of object like "identifiers": [ { "primary": true }, { "primary": false }, ] But the object inside array always need a name to create like "identifiers": [ { …
Raja
  • 239
  • 1
  • 5
  • 18
0
votes
1 answer

Intel XDK - Error when trying to consume Web Service from Explore Services panel

I am running Ubuntu 15.04 and when I try to call any web service from the Intel XDK -> Explore Services panel the response is something like: undefined is not a function TypeError: undefined is not a function at…
Jorge Cortes
  • 76
  • 5
0
votes
1 answer

Mashery IODocs - Latency issue due to heavy json config file

Mashery IOdocs is a really a great tools for documenting API. I'm using it for a quite big project with more then 50 methods and complex structures sent to this API, so that my json config file is more than 4000 lines long. I self-host IOdocs on a…
betelgeuz
  • 309
  • 4
  • 11
0
votes
1 answer

IODOCS configuration for POST webservices with ajax request

I want to POST below JSON string as part of request body in I/O DOC. {"Name":"ABCD","Alias":"PS","Date":"20140604","Status":"New","PdfPath":"/folder1/app.pdf"} What will be the configuration of endpoint? I am using below endpoint configuration, but…
Arko
  • 108
  • 1
  • 1
  • 8
0
votes
1 answer

Mashery IODocs - Can it support passportjs authentication from my REST API?

I am using iodocs from Mashery to be the developer front end to my REST API. My API is written with Node / Express, and uses PassportJS to authenticate the user (local strategy). My implementation requires the user to use the /login endpoint,…
Scott Switzer
  • 1,064
  • 1
  • 15
  • 25