farrow icon indicating copy to clipboard operation
farrow copied to clipboard

Feature Request: Automatically generating documentation

Open tqma113 opened this issue 3 years ago • 4 comments

In actual business development, there is a high demand for automatically generating documents

tqma113 avatar Jun 06 '21 07:06 tqma113

The codegen result of farrow-api is useful as documentation

class MyApiInput extends ObjectType {
  name = {
    description: 'the text in here will be convert to a comment for api consumer',
    deprecated: 'deprecated info',
    [Type]: String
}

It may be also useful to render the info to a web page.

Lucifier129 avatar Jun 06 '21 07:06 Lucifier129

Yes, It has the ability. But for the business development, it require more complete generation capability. Like GraphQL playground or another form.

tqma113 avatar Jun 06 '21 07:06 tqma113

Best practices for API version management are also needed.

tqma113 avatar Jun 06 '21 07:06 tqma113

It will be easy use implement a documentation generator via the introspection of farrow-api, render the JSON protocol to a pretty SPA page.

Are you interested in this direction? PR is welcome.

Lucifier129 avatar Jun 06 '21 09:06 Lucifier129