Flaredown icon indicating copy to clipboard operation
Flaredown copied to clipboard

Feat: Add RSwag to generate API Documentation

Open atinybeardedman opened this issue 2 years ago • 0 comments

Overview

Adds the rswag gem and generates the default specs for the existing controllers. This generates interactive documentation to view the Open API Documentation for the endpoints.

Notes

  • All the specs generated have been marked as pending, as they need to be filled in with correct details. These specs will actually hit the controller in order to generate the example data and will fail if they do not receive the correct response. Ideally future contributors to the repo can work incrementally on each spec to generate this example data.

atinybeardedman avatar Jul 30 '23 12:07 atinybeardedman