dox icon indicating copy to clipboard operation
dox copied to clipboard

Automated API documentation from Rspec

Results 9 dox issues
Sort by recently updated
recently updated
newest added

Curious if this is still an active project that just hasn't needed anything, or if it's gone dormant? Doing a survey of options to document my Rails API, and key...

Issue #58 Aim: Content-Type header in request sample section needs to match request Content-Type Solution: - Add rack gem dependancy because it is used in code - Use Content-Type instead...

The Content-Type header in request sample section does not match actual content type in the request: ![image](https://user-images.githubusercontent.com/78816643/137724926-cbfb3edf-0610-479a-bd1d-4a163dcee6a2.png) The cause of this issue is in the https://github.com/infinum/dox/blob/9734fdfd253901961005871fe040e43dcc4426e1/lib/dox/printers/example_request_printer.rb#L50 because it reads Accept...

bug
help wanted

The JSON format of input data in the generated redoc file shown as one line string includes all request data after adding base64 data as the value of one of...

Thanks for this great library! 🙏 [Open API Extensions](https://swagger.io/docs/specification/openapi-extensions/) are supported by some doc generators [like Redoc](https://github.com/Redocly/redoc/blob/master/docs/redoc-vendor-extensions.md) and allow us to add branding, e.g. `x-logo`. It would be great if...

How is the response picked up within rspec? I would like to replace some response values with something generic.

because of `instance_eval` i need to extend helpers module in each `action` example: ``` document :index do action 'Order Index' do extend ApiDoc::Shared params index_params path "/api/{version}/orders{?#{param_keys(index_params)}}" end end ```...

Thank you for this amazing gem! The schema option need to be added for header parameters. According to open api 3.0.0, parameters should have a schema property. ``` ... paths:...

Hello, could you please add Rack v3 support? Under the hood Dox uses `Rack::Multipart.extract_multipart` which stopped rewinding IO in [42aff22](https://github.com/rack/rack/commit/42aff22f708123839ba706cbe659d108b47c40c7). That leads to the failure in `Dox::Formatters::Multipart` when it's running...