feat: Documentation for Backend and Front-end APIs and in general#72
Open
Anurag-Bansode wants to merge 10 commits intoSrinjoyeeDey:mainfrom
Open
feat: Documentation for Backend and Front-end APIs and in general#72Anurag-Bansode wants to merge 10 commits intoSrinjoyeeDey:mainfrom
Anurag-Bansode wants to merge 10 commits intoSrinjoyeeDey:mainfrom
Conversation
Contributor
Author
|
Hi @SrinjoyeeDey, I have update the branch to the latest merge performed. |
Contributor
Author
|
@SrinjoyeeDey requesting you to review this PR and merge it at the earliest. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Hi @SrinjoyeeDey .
I have add the documentation for the backend; the developer just have to follow the template in previous code and same can be available on
http://localhost:4000/api-docsFrontend developer the can create exact objects which can also be tested via Swaggers Testing mechanism
Additional changes have been mention in readme.md
Just for Reference
Backend Documentations:
The Backend Documentation is generated using SwaggerUI
run
command
and now the documentation is available at
http://localhost:4000/api-docs.Frontend developer can refer to the same to create
jsonobjects.Frontend Documentations:
The Frontend Documentation is generated using Typedoc and tsdocs and can be build using
command.
The outputed static files will be available in /docs folder
The diff is long however all are just comments.
Please Note: changes have been made to package.json which include the following
Frontend: in scripts - new script added for doc generation
Backend: two swagger packages have been added
closes #68