Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature Request: Automatically generating documentation #83

Open
tqma113 opened this issue Jun 6, 2021 · 4 comments
Open

Feature Request: Automatically generating documentation #83

tqma113 opened this issue Jun 6, 2021 · 4 comments

Comments

@tqma113
Copy link
Collaborator

tqma113 commented Jun 6, 2021

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

@Lucifier129
Copy link
Collaborator

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.

@tqma113
Copy link
Collaborator Author

tqma113 commented Jun 6, 2021

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

@tqma113
Copy link
Collaborator Author

tqma113 commented Jun 6, 2021

Best practices for API version management are also needed.

@Lucifier129
Copy link
Collaborator

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants