farrow
farrow copied to clipboard
Feature Request: Automatically generating documentation
In actual business development, there is a high demand for automatically generating documents
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.
Yes, It has the ability. But for the business development, it require more complete generation capability. Like GraphQL playground or another form.
Best practices for API version management are also needed.
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.