search

alexjomin / openapi-parser

Simple and still naive openapi documentation generator from comments of your Go code.
18 stars 8 forks source link

feat: add import feature to load markdown in description #44

Closed alexjomin closed 3 years ago

alexjomin commented 3 years ago

Hey!

In order to avoid a huge API description right in the code, this PR is about adding an import feature to load the content of a markdown file.

This feature allows backward compatibility.

Example

// @openapi:info
// version: 0.0.1
// title: Awesome API
// description: import(README.md)

The resulting openapi specifications will contain the content of the README.md as a description.

Thanks in advance for the review!