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

Add support for documentation generation #14

Open
joshmossas opened this issue Nov 14, 2023 · 0 comments
Open

Add support for documentation generation #14

joshmossas opened this issue Nov 14, 2023 · 0 comments
Labels
codegen Issues related to generator plugins enhancement New feature or request

Comments

@joshmossas
Copy link
Member

joshmossas commented Nov 14, 2023

We should be able to support generating a complete API documentation site based on definition.json file similar to open API. It could work something like this.

arri document --definition [path-to-defitiion.json] --output [output-directory]

Ideally it would also detect what code generators are being used in the arri.config.ts and produce sample code for each client language being generated.

There also the possibility of just integrating this as a clientGenerator plugin:

import { defineConfig } from 'arri';
import { documentationGenerator } from 'arri/dist/codegen';

export default defineConfig({
  clientGenerators: [
    documentationGenerator()
  ]
});
@joshmossas joshmossas changed the title [arri] Add support for documentation generation [arri-codegen] Add support for documentation generation Dec 25, 2023
@joshmossas joshmossas changed the title [arri-codegen] Add support for documentation generation [arri] Add support for documentation generation Dec 25, 2023
@joshmossas joshmossas added the enhancement New feature or request label Mar 19, 2024
@joshmossas joshmossas added the codegen Issues related to generator plugins label Apr 12, 2024
@joshmossas joshmossas changed the title [arri] Add support for documentation generation [codegen] Add support for documentation generation Apr 12, 2024
@joshmossas joshmossas changed the title [codegen] Add support for documentation generation Add support for documentation generation May 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
codegen Issues related to generator plugins enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant