Generate API Integration Checklist Alongside Hooks

[harshmittal1750]

Description

Currently Orval generates typed clients, hooks, and query utilities extremely well from OpenAPI specifications.

However, when integrating generated hooks into large applications, developers still need to manually determine:

• which hooks are unused
• which endpoints are not integrated yet
• required integration dependencies
• missing CRUD coverage
• integration progress/status

This becomes harder in medium-to-large codebases where APIs evolve quickly and multiple teams work on the frontend simultaneously.

Current behavior

Orval successfully generates hooks such as:

• useGetUsers
• useCreatePost
• useInfiniteFeed

But there is no visibility layer or integration checklist generated alongside them.

Developers often end up:

• manually tracking integration progress
• searching codebase usage
• maintaining spreadsheets/docs
• forgetting unused or partially integrated endpoints
• missing mutations/query invalidation relationships

This creates friction especially in:

• enterprise apps
• rapidly evolving APIs
• large React Query codebases
• AI-assisted/vibe-coded projects

Proposed behavior

Provide an optional feature to generate an integration manifest/checklist alongside generated hooks.

Example output:

{
  "users": {
    "hooks": [
      "useGetUsers",
      "useCreateUser",
      "useDeleteUser"
    ],
    "integrated": false,
    "dependencies": [
      "auth",
      "queryClient"
    ]
  }
}

Or optionally generate:

• markdown checklist
• JSON manifest
• integration status file
• dependency graph metadata

Proposed solution

Add a configurable generator option such as:

output:
  integrationChecklist: true

Possible outputs:

• orval.integration.json
• orval.checklist.md

Potential metadata:

• generated hooks
• endpoint grouping
• mutation/query relationships
• cache invalidation dependencies
• integration status placeholders
• route/module ownership

This could also unlock:

• IDE tooling
• dashboard integrations
• AI-assisted integration workflows
• automated coverage analysis

I’d be happy to work on this feature if the maintainers think it aligns with Orval’s vision.

[melloware]

hnmm i am not sure about this. It is sort of outside the realm of Orval. @anymaniax @soartec-lab @snebjorn thoughts?

[snebjorn]

agree, it's outside the scope of generating http clients :)

[soartec-lab]

I agree too. If you'd like to create that tool yourself, k6 repository might be helpful:

https://github.com/grafana/openapi-to-k6/tree/main/src/generator