Stack Overflow
Stack Overflow

Questions tagged [rspec-api-documentation]

A Ruby gem used most often with Ruby on Rails applications. It allows one to generate pretty API documentations using RSpec syntax.

Github: https://github.com/zipmark/rspec_api_documentation

Relish documentation: http://www.relishapp.com/zipmark/rspec-api-documentation/docs

19 questions
0
votes
2 answers

rspec_api_documentation resources can have explanations. So why they don't show in raddocs html?

Resources in RspecApiDocumentation can have explanations. But they don't show when using json format with raddocs html browser. Example: user_spec.rb: resource 'User' do explanation "a User resource, duh" ... index.json: { "name": "User", …
MikeMarsian
  • 608
  • 1
  • 7
  • 21
0
votes
1 answer

uninitialized constant RspecApiDocumentation using apitome

When following the instructions for setting up aptitome with rspec_api_documentation, I receive the following error: uninitialized constant RspecApiDocumentation How do I fix this?
Obromios
  • 15,408
  • 15
  • 72
  • 127
-1
votes
0 answers

SimpleCov failed with exit 1 + google-protobuf

Hi, i'm working on project which has ruby version 2.4.6 and rails version 5.0.2, iv'e implemented rspec_api_documentation and apitome gem for api documentation. I wrote all the test cases and when i run it with simple rspec…
Muhammad Minhas
  • 1
-2
votes
1 answer

Does postman API documentation support tryout feature similar as swagger

Does postman API documentation support tryout feature similar as swagger and suggest best tool for the API documentation
Pawan Kumar Rakesh
  • 33
  • 1
  • 3
1
2