Skip to content
This repository has been archived by the owner on Apr 6, 2023. It is now read-only.

docs: add server routes documentation #4174

Merged
merged 18 commits into from
Apr 9, 2022
Merged

docs: add server routes documentation #4174

merged 18 commits into from
Apr 9, 2022

Conversation

Diizzayy
Copy link
Member

@Diizzayy Diizzayy commented Apr 7, 2022

  • 📖 Documentation (updates to the documentation or readme)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • 👌 Enhancement (improving an existing functionality like performance)
  • ✨ New feature (a non-breaking change that adds functionality)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

📚 Description

This PR updates the documentation to detail possible usage and use cases of API Routes

📝 Checklist

  • I have linked an issue or discussion.
  • I have updated the documentation accordingly.

@netlify
Copy link

netlify bot commented Apr 7, 2022 •
edited
Loading

✅ Deploy Preview for nuxt3-docs ready!

Name Link
🔨 Latest commit 30a5c3c
🔍 Latest deploy log https://app.netlify.com/sites/nuxt3-docs/deploys/62516f8b997dbe0008da5e33
😎 Deploy Preview https://deploy-preview-4174--nuxt3-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

pi0
pi0 reviewed Apr 7, 2022
View reviewed changes
docs/content/2.guide/2.features/9.api-routes.md Outdated Show resolved Hide resolved
docs/content/2.guide/2.features/9.api-routes.md Outdated
```ts [server/api/node.ts]
import type { IncomingMessage, ServerResponse } from 'http'

export default async (req: IncomingMessage, res: ServerResponse) => {
Copy link
Member

Choose a reason for hiding this comment

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

Let's not advocate this or if doing, mentioning is mainly for supporting legacy middleware and advanced use. h3 is dropping node dependency progressively (unjs/h3#73)

Copy link
Member Author

Choose a reason for hiding this comment

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

taking that into consideration, do you think the best forward thinking resolve would just be to avoid mentioning it altogether?

docs/content/2.guide/2.features/9.api-routes.md Outdated Show resolved Hide resolved
docs/content/2.guide/2.features/9.api-routes.md Outdated Show resolved Hide resolved
docs/content/2.guide/2.features/9.api-routes.md Outdated Show resolved Hide resolved
docs/content/2.guide/2.features/9.api-routes.md Outdated Show resolved Hide resolved
docs/content/2.guide/2.features/9.api-routes.md Outdated Show resolved Hide resolved
@pi0 pi0 added documentation Improvements or additions to documentation changes-requested labels Apr 7, 2022
@Diizzayy @pi0
docs: catch-all route
f9ded09 
Co-authored-by: pooya parsa <[email protected]>
@Rigo-m
Copy link
Contributor

Rigo-m commented Apr 7, 2022

Should we migrate from using h3's defineHandler?

@pi0
Copy link
Member

pi0 commented Apr 7, 2022 •
edited
Loading

Should we migrate from using h3's defineHandler?

Definitely! (marking it as deprecated soon)

@Rigo-m
Copy link
Contributor

Rigo-m commented Apr 7, 2022

It would be really helpful from a formative standpoint to understand the whys behind moving from defineHandler to the new h3 method :)

@pi0
Copy link
Member

pi0 commented Apr 7, 2022

unjs/h3#73

@Diizzayy Diizzayy requested a review from pi0 April 7, 2022 18:26
@ikadix ikadix mentioned this pull request Apr 7, 2022
Closed
@Diizzayy Diizzayy mentioned this pull request Apr 7, 2022
Merged
7 tasks
@pi0 pi0 changed the title docs: add API Routes documentation docs: add server routes documentation Apr 9, 2022
@pi0 pi0 merged commit 529712d into nuxt:main Apr 9, 2022
@pi0
Copy link
Member

pi0 commented Apr 9, 2022

Thanks for help @Diizzayy 👍🏼

@Diizzayy Diizzayy deleted the docs/api-routes branch April 9, 2022 11:38
@danielroe danielroe added the 3.x label Jan 19, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@atinux atinux atinux left review comments

@pi0 pi0 Awaiting requested review from pi0

Assignees
No one assigned
Labels
3.x documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@Diizzayy @Rigo-m @pi0 @atinux @danielroe