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.

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

chore: swagger API documentation #21

Merged
merged 1 commit into from
Apr 24, 2024
Merged

chore: swagger API documentation #21

merged 1 commit into from
Apr 24, 2024

Conversation

MC-Knight
Copy link
Contributor

What does this PR do?

This pull request aims to add swagger API documentation to knights-ecomm-be project

Description of Task to be completed?

The task completed in this pull request includes:

  • setting up swagger API documentation tool in project
  • adding endpoint to access swagger documentation ui

How should this be manually tested?

To manually test all the changes made in this pull request, follow these steps:

git clone -b ft-api-docs https://github.com/atlp-rwanda/knights-ecomm-be.git
cd knights-ecomm-be
npm i
npm run dev
access http://localhost:{port}/api/v1/docs

example

image
image

@MC-Knight MC-Knight added the Ready for reviews Pull request is ready for review label Apr 24, 2024
@MC-Knight MC-Knight self-assigned this Apr 24, 2024
@MC-Knight MC-Knight linked an issue Apr 24, 2024 that may be closed by this pull request
2 tasks
Copy link
Contributor

@elijahladdie elijahladdie left a comment

Choose a reason for hiding this comment

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

Well done Joe

Copy link
Contributor

@aimedivin aimedivin left a comment

Choose a reason for hiding this comment

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

Good job 👍🏿

Copy link
Collaborator

@faid-terence faid-terence left a comment

Choose a reason for hiding this comment

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

Nice Work @MC-Knight !

@faid-terence faid-terence merged commit 502c899 into develop Apr 24, 2024
1 check passed
@MC-Knight MC-Knight added documentation Improvements or additions to documentation chore chore story backend Good for newcomers and removed Ready for reviews Pull request is ready for review labels Apr 28, 2024
@mukunzidd mukunzidd added this to the Chores milestone Apr 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backend Good for newcomers chore chore story documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

chore: API Documentation
5 participants