Skip to content

feat: add nuxt-api-sdk#1501

Open
JamieCurnow wants to merge 3 commits into
nuxt:mainfrom
JamieCurnow:add-api-sdk
Open

feat: add nuxt-api-sdk#1501
JamieCurnow wants to merge 3 commits into
nuxt:mainfrom
JamieCurnow:add-api-sdk

Conversation

@JamieCurnow
Copy link
Copy Markdown
Contributor

🔗 Linked issue: closes #1312

📚 Description: adds nuxt-api-sdk (npm).

A Nuxt module that turns your server/api routes into a fully-typed, chainable SDK. It scans your Nitro handlers and generates a useApi() composable with end-to-end type-safety and autocompletion, so you can call useApi().user.uid(uid).get() instead of $fetch(/api/user/${uid}). Also ships a defineBodyType utility for typing request bodies.

Category: Request

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings June 5, 2026 16:24
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Adds a new module registry entry for api-sdk (nuxt-api-sdk) to describe and categorize the package and its Nuxt compatibility.

Changes:

  • Introduced modules/api-sdk.yml with metadata (name, description, links, category/type).
  • Added maintainer information and Nuxt compatibility range.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Jun 5, 2026

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 4e819185-f49b-4082-bada-7f85327bdc45

📥 Commits

Reviewing files that changed from the base of the PR and between 2b037e0 and f181f6c.

📒 Files selected for processing (1)
  • modules/api-sdk.yml
✅ Files skipped from review due to trivial changes (1)
  • modules/api-sdk.yml

📝 Walkthrough

Walkthrough

Adds a new module manifest file modules/api-sdk.yml to register the api-sdk module in the Nuxt modules registry. The manifest includes name, description, repo and npm links, icon, links, maintainer, category and type, and declares Nuxt compatibility >=4.0.0 with an empty requires object.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title 'feat: add nuxt-api-sdk' directly describes the main change—adding a new module manifest entry for nuxt-api-sdk.
Description check ✅ Passed The description provides relevant context about the module being added, its functionality, and references the linked issue #1312.
Linked Issues check ✅ Passed The PR adds the nuxt-api-sdk module manifest as requested in #1312, making the module discoverable in the Nuxt modules registry.
Out of Scope Changes check ✅ Passed The change is limited to adding a single module manifest file (api-sdk.yml), which is directly in scope for the module listing request.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (1)
modules/api-sdk.yml (1)

5-5: 💤 Low value

Consider adding an icon and documentation link.

While optional, providing an icon (line 5) would improve the module's visibility in the Nuxt modules directory, and a learn_more link (line 8) would help users find comprehensive documentation beyond the GitHub README.

Also applies to: 8-8

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@modules/api-sdk.yml` at line 5, Add a descriptive icon and a documentation
link by populating the YAML keys `icon` and `learn_more`: set `icon` to a short
identifier or path for the module icon (e.g., an SVG filename or emoji) and set
`learn_more` to the canonical documentation URL (e.g., your docs site or a
dedicated README page) so the module listing shows an icon and a direct "learn
more" link for users.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Nitpick comments:
In `@modules/api-sdk.yml`:
- Line 5: Add a descriptive icon and a documentation link by populating the YAML
keys `icon` and `learn_more`: set `icon` to a short identifier or path for the
module icon (e.g., an SVG filename or emoji) and set `learn_more` to the
canonical documentation URL (e.g., your docs site or a dedicated README page) so
the module listing shows an icon and a direct "learn more" link for users.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 8b4eed3d-1cf2-4d55-bf84-1bb5d4c2526a

📥 Commits

Reviewing files that changed from the base of the PR and between ef41a04 and 6f164e6.

📒 Files selected for processing (1)
  • modules/api-sdk.yml

JamieCurnow and others added 2 commits June 5, 2026 17:29
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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

Successfully merging this pull request may close these issues.

[Module Listing Request]: Nuxt API SDK

2 participants