Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document API Routes in POSTMAN and Generate API Documentation #212

Open
7 tasks
prasenjeet-symon opened this issue Oct 20, 2023 · 43 comments
Open
7 tasks

Document API Routes in POSTMAN and Generate API Documentation #212

prasenjeet-symon opened this issue Oct 20, 2023 · 43 comments
Assignees
@Believet2
Labels
beginner-friendly documentation Improvements or additions to documentation EddieHub:good-first-issue good first issue Good for newcomers hacktoberfest hacktoberfest-accepted help wanted Extra attention is needed server related to server
Milestone
Milestone 1: Serv...

Comments

@prasenjeet-symon
Copy link
Owner

Title: Document API Routes in POSTMAN and Generate API Documentation

Description:
This GitHub issue focuses on documenting all the existing API routes in POSTMAN to improve the accessibility and understanding of our APIs. It involves creating API documentation with clear descriptions, request examples, and response structures for each route. Additionally, we'll generate API documentation and add a link to the README file for easy reference.

Tasks:

  1. API Route Documentation:

    • Create POSTMAN documentation for each existing API route.
    • Include detailed descriptions of each route, specifying the purpose and functionality.
    • Add request examples to demonstrate how to interact with each API, including required parameters and headers.
    • Document the expected response structure for each route, indicating the possible status codes and response payloads.

  2. API Documentation Generation:

    • Generate API documentation in POSTMAN using the documented API routes.
    • Ensure that the POSTMAN documentation reflects the latest state of our APIs.

  3. README Update:

    • Add a link to the generated API documentation in the README file to make it easily accessible for developers.

Acceptance Criteria:

  • Each existing API route is documented in POSTMAN with clear descriptions, request examples, and response structures.
  • The POSTMAN documentation accurately reflects the latest state of our APIs.
  • A link to the generated API documentation is added to the README file for easy reference.

Additional Information:

  • Documenting our APIs enhances their accessibility and usability.
  • Keeping the documentation up-to-date is essential to ensure developers have accurate information.
  • The README file serves as a central hub for accessing API documentation.
@prasenjeet-symon prasenjeet-symon added documentation Improvements or additions to documentation help wanted Extra attention is needed good first issue Good for newcomers server related to server EddieHub:good-first-issue beginner-friendly hacktoberfest hacktoberfest-accepted labels Oct 20, 2023
@Shuhua-L
Copy link

Hi, I would like to work on this issue, can you assign it to me?

@prasenjeet-symon
Copy link
Owner Author

@Shuhua-L Yes, assigned to you

@kenudeh
Copy link

kenudeh commented Dec 1, 2023

Hi, what is the state of this project now? Still open for contribution?

@prasenjeet-symon
Copy link
Owner Author

Hi, what is the state of this project now? Still open for contribution?

Yes it is open . We need clear and concise API documentation.

@kenudeh
Copy link

kenudeh commented Dec 1, 2023

Alright, can you please direct me to where the endpoints and other relevant details are defined?

@prasenjeet-symon
Copy link
Owner Author

Alright, can you please direct me to where the endpoints and other relevant details are defined?

Check the server folder, there are API routes ( in a specific folder ). And use link on the readme to setup POSTMAN

@kenudeh
Copy link

kenudeh commented Dec 1, 2023

Ok, I'll go through everything and get back to you.

@kenudeh
Copy link

kenudeh commented Dec 4, 2023

Hi Prasenjeet! I can work on this documentation. So far, I have cloned the POSTMAN collection, however, I am having issues cloning the repository to my local machine. I'm getting the following error:

"[email protected]: Permission denied (publickey).
fatal: Could not read from remote repository.

Please make sure you have the correct access rights
and the repository exists."

I'm still trying to see if I can resolve it myself, but I'd welcome your assistance.

@prasenjeet-symon
Copy link
Owner Author

Hi Prasenjeet! I can work on this documentation. So far, I have cloned the POSTMAN collection, however, I am having issues cloning the repository to my local machine. I'm getting the following error:

"[email protected]: Permission denied (publickey). fatal: Could not read from remote repository.

Please make sure you have the correct access rights and the repository exists."

I'm still trying to see if I can resolve it myself, but I'd welcome your assistance.

Hi. I think this is the basis of cloning the public repository. Can you watch some YouTube vids that will make it super clear. Thanks

@kenudeh
Copy link

kenudeh commented Dec 15, 2023

I've resolved the issue and started the app, but I'm unable to create an account. The "sign up with Goggle" link isn't working either.

@prasenjeet-symon
Copy link
Owner Author

I've resolved the issue and started the app, but I'm unable to create an account. The "sign up with Goggle" link isn't working either.

This issue is related to server side , and need no client interaction . Setup POSTMAN and start the server that's all. We are working on the client side , but we want to finish server-side task first .

@kenudeh
Copy link

kenudeh commented Dec 15, 2023

Just ran into another issue. The server isn't running on localhost:3001 and I believe it has to do with the following error I got:

[nodemon] app crashed - waiting for file changes before starting...

I'm sure it's why I'm not getting any response on POSTMAN, as contained in the README guide.

@prasenjeet-symon
Copy link
Owner Author

Just ran into another issue. The server isn't running on localhost:3001 and I believe it has to do with the following error I got:

[nodemon] app crashed - waiting for file changes before starting...

I'm sure it's why I'm not getting any response on POSTMAN, as contained in the README guide.

Okay i will take a look . Weather server is running or not .

@Believet2
Copy link

Hi i will like to be part of this, can you pls assign me?

@Believet2
Copy link

Thank you @prasenjeet-symon, so are we working individually or we can work as a team?

@prasenjeet-symon
Copy link
Owner Author

Thank you @prasenjeet-symon, so are we working individually or we can work as a team?

If you can work individually, that would be great. Thanks.

@Believet2
Copy link

For the sake of me begin a first timer can i work with someone that can help me? cuz im looking to gain experience and this is my time contributing to an open source project pls.

@prasenjeet-symon
Copy link
Owner Author

For the sake of me begin a first timer can i work with someone that can help me? cuz im looking to gain experience and this is my time contributing to an open source project pls.

Do you understand the issue ?? if not plzz ask me any questions you may have . I will help you understand the issue.

@Believet2
Copy link

For the sake of me begin a first timer can i work with someone that can help me? cuz im looking to gain experience and this is my time contributing to an open source project pls.

Do you understand the issue ?? if not plzz ask me any questions you may have . I will help you understand the issue.

i will be very glad if i can attach with someone to work on this, plzz this is my first time. plzzzzz

@Believet2
Copy link

For the sake of me begin a first timer can i work with someone that can help me? cuz im looking to gain experience and this is my time contributing to an open source project pls.

Do you understand the issue ?? if not plzz ask me any questions you may have . I will help you understand the issue.

i don't understand the issue very clearly, i need a deep explanation

@prasenjeet-symon
Copy link
Owner Author

Well there are multiple api routes in server folder . Your task to is to add that to postman and also document it to the postman API documentation.

@Believet2
Copy link

what about cloning the repo to local machine, does it still solve and issue?

@prasenjeet-symon
Copy link
Owner Author

what about cloning the repo to local machine, does it still solve and issue?

Have you ever worked with API before?

@Believet2
Copy link

what about cloning the repo to local machine, does it still solve and issue?

Have you ever worked with API before?

no, that is why i am seeking for someone to work with on this, i just finish learning technical writing and API documentation

@Believet2
Copy link

Just ran into another issue. The server isn't running on localhost:3001 and I believe it has to do with the following error I got:

[nodemon] app crashed - waiting for file changes before starting...

I'm sure it's why I'm not getting any response on POSTMAN, as contained in the README guide.

Hello @kenudeh can i pair with you to work on this project, i am a newbies and will like someone to work with in other for me to gain experience

@Believet2
Copy link

So nobody is willing to help me?

@Believet2
Copy link

Seems the link to the APIs are not working

@prasenjeet-symon
Copy link
Owner Author

So nobody is willing to help me?

Sorry about that, Make sure to have a clear and good understanding of API/POSTMAN . You can watch and read good videos about these topics. Thanks

@prasenjeet-symon
Copy link
Owner Author

Seems the link to the APIs are not working

We will take a look since I am currently busy with the Sculify Work.

@kenudeh
Copy link

kenudeh commented Dec 26, 2023

Hi Prasenjeet-symon, were you able to confirm if the server is running or not? It didn't start on my machine when I tried. That meant I couldn't get any response to plug into POSTMAN.

@kenudeh
Copy link

kenudeh commented Dec 26, 2023

@Believet2 just read the instructions contained on the Readme, it's self-explanatory. If I'm able to solve the technical issue I faced, I wouldn't mind carrying you along anyway.

@prasenjeet-symon
Copy link
Owner Author

Hi Prasenjeet-symon, were you able to confirm if the server is running or not? It didn't start on my machine when I tried. That meant I couldn't get any response to plug into POSTMAN.

I will check and let you know

@kenudeh
Copy link

kenudeh commented Dec 26, 2023 via email

@Believet2
Copy link

@Believet2 just read the instructions contained on the Readme, it's self-explanatory. If I'm able to solve the technical issue I faced, I wouldn't mind carrying you along anyway.

Alright @prasenjeet-symon

@Believet2
Copy link

@prasenjeet-symon has the server been resloved?

@prasenjeet-symon
Copy link
Owner Author

@prasenjeet-symon has the server been resloved?

Hey @Believet2 can you plzz share the screenshot of error , so that i can take a look.

@Believet2
Copy link

@prasenjeet-symon
Uploading Capture.PNG…

@prasenjeet-symon
Copy link
Owner Author

@Believet2 Image not uploaded successfully. Plzz try again

@Believet2
Copy link

Capture

@Believet2
Copy link

Capture

@prasenjeet-symon

@prasenjeet-symon
Copy link
Owner Author

prasenjeet-symon commented Jan 9, 2024 •
edited
Loading

I have tested server is running fine. You need to learn how to setup the postman there is doc on the readme file. @Believet2

@Believet2
Copy link

Do I have to install docker on my system? Cuz I have forked the repository in postman and it still shows me same error message

@satokenta940
Copy link

It's great, but I recommend using Apidog to record and generate API documentation. I'm currently doing this, and it has been very effective.



Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Believet2 Believet2

Labels
beginner-friendly documentation Improvements or additions to documentation EddieHub:good-first-issue good first issue Good for newcomers hacktoberfest hacktoberfest-accepted help wanted Extra attention is needed server related to server
Projects
None yet
Milestone
Milestone 1: Server API Development
Development

No branches or pull requests
5 participants
@kenudeh @prasenjeet-symon @Shuhua-L @Believet2 @satokenta940