Add API documentation

[BrunnerLivio]

PR Checklist

Please check if your PR fulfills the following requirements:

• The commit message follows our guidelines: https://github.com/nestjs/nest/blob/master/CONTRIBUTING.md
• Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

[ ] Bugfix
[ ] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[x] Other... Please describe:
Documentation

Does this PR introduce a breaking change?

[ ] Yes
[x] No

[coveralls]

Pull Request Test Coverage Report for Build 4086

• 0 of 0 changed or added relevant lines in 0 files are covered.
• No unchanged relevant lines lost coverage.
• Overall coverage remained the same at 95.236%

---

Totals
Change from base Build 4084:	0.0%
Covered Lines:	3638
Relevant Lines:	3820

---

💛 - Coveralls

[BrunnerLivio]

I think the cors option is also usable for Fastify, right? I think we should not add an express link in that case.

[BrunnerLivio]

Suggested change

	* Use when you want to override default `socket.io` library.
	* Use when you want to override default `socket.io` library.

Could be anything - lets not assume it is socket.io

[BrunnerLivio]

@kamilmysliwiec The commit history is currently a mess - would you be ok with squashing all the commits into one?

[johnbiundo]

I've been tracking my progress here: https://docs.google.com/spreadsheets/d/1M80PQuiyQznHbi802QLhvSeWF9Tba6jJeqtc2wY0YZU/edit?usp=sharing

I've been noting a bunch of questions/comments there that might be worth looking at once you've done a basic review.

[BrunnerLivio]

@kamilmysliwiec more information on the tag definitions, see here

[kamilmysliwiec]

Can we merge it already? :) (at least everything what we have so far)

[BrunnerLivio]

Lets rebase first. @johnbiundo ping me on Discord if you need assistance :)

[johnbiundo]

@BrunnerLivio I am not sure how soon I can get to this as I'm serving on jury duty the rest of this week. Feel free to proceed with this if you would like :)

[BrunnerLivio]

There we go, squashed into 6 commits. @johnbiundo you are still the author for your commits :)

[johnbiundo]

Awesome. Thanks @BrunnerLivio

[kamilmysliwiec]

@johnbiundo a few notes:

• why @publicApi is sometimes at the beginning of the comment (usually it's located at the end)?
• some comments aren't available in the .d.ts files (I sent you a screenshot on Discord)

[johnbiundo]

@kamilmysliwiec Thanks for the review.

re: @publicApi: just an inconsistency on my part since we started with it at the top. I've been gradually correcting it since we decided it belongs at the bottom.

re: comments in overloaded functions/methods: Same: once we discovered the pattern, I've been trying to reproduce a slightly different (mainly, in signature only) version of the comment for each overloaded method. I'll eventually make a final pass through all of them and make sure this is done.

[kamilmysliwiec]

Thanks for clarification @johnbiundo. For the sake of consistency (publicApi), can we move them all at the bottom before we merge this PR?

Same: once we discovered the pattern, I've been trying to reproduce a slightly different (mainly, in signature only) version of the comment for each overloaded method. I'll eventually make a final pass through all of them and make sure this is done.

That would be awesome!

[johnbiundo]

@kamilmysliwiec will do (re: @publicApi ASAP.

[BrunnerLivio]

@kamilmysliwiec: @johnbiundo and I realized we had not pushed Johns last commits. We did a recovery mission and now it is restaged as before (same commit history). From the formatting: Now @publicApi is always at the last position of the comment and @description is completely removed :)

• Merge conflicts resolved with 6.6.0 branch

[kamilmysliwiec]

Amazing job! Thanks guys, let me pull this branch

[kamilmysliwiec]

Such an amazing piece of work! Thanks again, merging to 6.6.0 branch :)

[fwoelffel]

Hi guys! Thanks for this amazing work 👏
I'm wondering if this documentation will get published somewhere?

[BrunnerLivio]

Hi @fwoelffel. This PR is related to two goals:

• Improve DX by having documentation in code, so VSCode can display it in your editor
• Add visual API docs which can be displayed on docs.nestjs.com

I guess your question is regarding the online documentation? We are currently in the process for that quite some time. There is docs.nestjs.com#413 which already generates API docs in visual form.

This feature is quite a big change, therefore we broke it down in multiple tasks

• Add API docs in the correct format to all integrations and packages - In Progress
• Rewrite the documentation generator to dgeni - Done docs.nestjs.com#556
• Remove all the src/app/pages/* components so all the content of the docs can be generated without adding a component - Todo docs.nestjs.com#549.
• Add API docs - In progress docs.nestjs.com#413

Since I am currently quite busy with my job, I have trouble to push this further at the moment. I hope for more time in the future, but can't tell at the moment unfortunately. If you would like to contribute, let me know :)

[fwoelffel]

Thanks for the quick response @BrunnerLivio
I'll check these tasks out and maybe provide some help with it if my time schedule allows for it :)

[BrunnerLivio]

@fwoelffel that would be awesome. In general the next step I would have taken would have been docs.nestjs.com#549. If you need some guidance on how to do that, you should definitely read through the issue and you can also ping me on Discord for further guidance :)

[lock]

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.