We are using rspec_api_documentation and managed to generate the documentation for the 2 versions we have so far with the following code:
RspecApiDocumentation.configure do |config|
config.docs_dir = Rails.root.join('doc', 'api', 'all')
…
My goal is to show multiple examples of parameters and responses using rspec_api_documentation with rswag-ui or by adding swagger-ui directly to the project. I'm having some trouble generating the correct open_api.json with my config and am…
I've just started using rspec_api_documentation and cannot get it to work with my api. Created simple spec, as basic as first example in the readme but it keeps throwing undefined method 'call' for nil:NilClass error at me, and I have no idea what…
I'd like to manually serialize a collection for testing purposes. I tried this:
JSONAPI::ResourceSerializer.new(PostResource).
serialize_to_hash(PostResource.new(Post.all))
This doesn't work. It appears you can only serialize a single resource…
I want to render these through Apitome but they only return http. I'm able to set the other headers with:
header 'Authorization', 'Token token=secret'
header 'Content-Type', 'application/vnd.api+json'
header 'Host',…
While using the rspec-api-documentation gem in markdown mode (config.format = [:markdown]) I noticed that the documentation generated is lacking the response body.
Is there a permanent fix for this?
I'm using the RSpec API Documentation Generator Gem for my rails app, and when I generate the docs, the request body (JSON format) is formatted like so:
{"user":{"email":"person1@example.com","password":"z5x6c7v8!@!"}}
is there a way to pretty…
I've successfully used rspec_api_documentation gem to generate docs for some other resources in an application.
But when I do the same for a new resource, the JSON file's response_body is empty (though the rest of the JSON exists). And I'm unsure…
I am using rspec api documentation, apitome and oauth2 protocol to build acceptance test to our api. Everything works great with one exception that the request body shown as below:
What I noticed from the generated doc above:
Content-Type:…
I am trying to separate my API docs to public and developers documentation, so that I can have separate docs which I can give to people other than me.
For this I am using Rails and gem known as rspec_api_documentation, however I can't get it to…
I am trying to update API documentation for REST APIs.
Currently, I have a C# Asp.net Web API code and Swashbuckle.AspNetCore.
I am editing and adding XML comments in C# using Visual Studio to update the API documentation.
Is there a way I can do…
I' working on the tests and documentation of a searches endpoint that I implemented. I'm having trouble with properly adding the query params. Basically the request url should look like…
I am using the rspec_api_documentation and apitome gems in a version 5.2 ruby on rails app.
This produces excellent documentation, and has a sidebar (div#sidebar) to allow quick access to the correct part of the documentation. When I choose the…
I am using rspec_api_documentation and apitome to generate api documentation. When I view the apitome output in the browser, there is a link entitled 'Simulated Response'. When I click on this, I get the following error:
Missing template…
