docs(vercel): add note about top level api/ directory

[rieger-jared]

After following the initial project scaffolded via the command npx giget@latest nitro nitro-app I found that after deploying to vercel via vercel command my routes were not at the expected place of domian.com/api/hello/.

I added this documentation to hopefully help future developers wishing to deploy to vercel not waste time understanding the mapping of routes.

I found the solution via this GitHub discussion

#233

🔗 Linked issue

❓ Type of change

• 📖 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

📝 Checklist

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

[nuxt-studio]

✅ Live Preview ready!

Name	Edit	Preview	Latest Commit
nitro	Edit on Studio ↗︎	View Live Preview	39e68bc

[codecov]

Codecov Report

Merging #1386 (39e68bc) into main (f0d0d91) will decrease coverage by 0.36%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #1386      +/-   ##
==========================================
- Coverage   76.73%   76.37%   -0.36%     
==========================================
  Files          71       71              
  Lines        7273     7273              
  Branches      727      721       -6     
==========================================
- Hits         5581     5555      -26     
- Misses       1691     1717      +26     
  Partials        1        1              

see 2 files with indirect coverage changes

[Hebilicious]

This is welcomed, altough this is mentioned in the docs already here: https://nitro.unjs.io/guide/routing, it's easy to miss.

[rieger-jared]

This is welcomed, altough this is mentioned in the docs already here: https://nitro.unjs.io/guide/routing, it's easy to miss.

Thanks! I was a little confused by this page. I'm very new to the project so I assume this might be obvious for more seasoned nuxt devs who are familiar with nitro.

Are you talking about this quote from the page you linked?

Due to some providers like Vercel using top-level api/ directory as a feature, Nitro also supports routes/api/ to create API routes.

[Hebilicious]

That's the one yes !

[rieger-jared]

Ok, perhaps then I'll add to the original quote.

[rieger-jared]

@Hebilicious I reworded the original documentation. What do you think?

[Hebilicious]

@rieger-jared I liked your initial idea of adding more instructions within Vercel, so I added a section there. Does this looks more comprehensible to you ?

[rieger-jared]

Yeah, looks good to me! I think it's also good that we include it in the deployment section as I'm sure most people won't hold the link between the doc sections. Thank you for adding that back in!

[rieger-jared]

❤️