Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 5 years ago.
Improve this question
Is there a tool or an easy way to generate/maintain documentation of a rich RESTful JSON API?
I also would want to publish and maintain (as executable documentation) it, something like what relishapp provides. An example.
The application is Restful Ruby on Rails 3 application, tested using cucumber and R-Spec controller tests.
You say you have Cucumber tests already - they are your documentation. They may just need some work to be readable.
For output, you can use Cucumber's built-in HTML formatter.
Related
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 5 years ago.
Improve this question
I like the idea of relishapp.com, i.e. that you have Cucumber / Gherkin features and you generate "living docs" from them. However, the Relish SaaS is awful.
I'm looking for an alternative. Ideally self-hosted Open Source like Sphinx, but I'm not completely opposed to SaaS solutions. Especially Sphinx would be great as I could combine it with other docs and use readthedocs.org for deployment.
So the question is: What would be the easiest way to generate HTML docs from Gherkin features?
There is one more option Cukedoctor https://github.com/rmpestano/cukedoctor
You can host within company network using SimpleHTTPServer ( http://2ality.com/2014/06/simple-http-server.html )
I've used yard-cucumber to do that before. It worked out pretty well.
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 5 years ago.
Improve this question
Are there any plugins out there (similar to Swagger) which provide the ability to document HATEOAS APIs?
The Swagger interface is quite good but it doesn't have level 3 REST support.
I use spring-restdocs in combination with the HAL-browser.
You don't necessarily need HAL for restdocs though, although it is recommended.
Restdocs will generate code samples and link & field descriptors in the asciidoc format. You can then link to these asciidocs from inside the HAL-browser.
To see the result in action (although this is hardcoded), check this out: foxycart. Click on the little doc links next to the rels.
After further investigation I discovered HAL-browser (https://github.com/mikekelly/hal-browser) which is quite good. Although, your API must return content-type of HAL for it.
You don't need to configure anything on the server for this tool. Just open it in a browser and point to your API.
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 5 years ago.
Improve this question
Is there an easy way to generate docs for REST api direct from a Symfony project?
Sorry for the post digging, but there is a Symfony bundle to help API doc generation, you can check out NelmioApiDocBundle which interconnects well with FOSRestBundle.
The FOSRestBundle documentation provides sample bundles using both bundles to generate REST-ful web services and their documentation.
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 4 years ago.
Improve this question
I want to write APIs for my rails 3.1 application but have never written an API ever. I am supposed to write REST and SOAP APIs. Is there a formal book or e-book or screencasts or tutorials which teaches about APIs in Rails and best practices?
have a look at Grape. It's a micro-framework to build REST apis, with a rails implementation example provided.
As for SOAP, don't know, but Savon seems fine.
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 6 years ago.
Improve this question
I am finding load testing tool that can send PUT/DELETE requests.
Neither ApacheBench nor JMeter supports these methods.
After several hours' googling, I found SoapUI that looks good.
Do you have any other recommendation?
Command line tool like ApacheBench will be better for me.
The Grinder is a decent load testing framework that also supports PUT and DELETE.
Jmeter supports put and delete methods as of of versions > to 2.5 ( didn't Check for others)