Skip to content

Commit

Permalink
πŸ™†β€β™‚οΈ postman setup guide
Browse files Browse the repository at this point in the history
  • Loading branch information
jiisanda committed Dec 31, 2023
1 parent b6528b9 commit 1877557
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 5 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ DocFlow is a powerful Document Management API designed to streamline document ha

Explore the [API Documentation](https://documenter.getpostman.com/view/20984268/2s9YRGxUcp) for detailed information on how to use DocFlow's features.

Details about features and commands can be found [here](app/docs).

Download docker image from [docker-hub](https://hub.docker.com/r/jiisanda/docflow).

Or just run
Expand All @@ -40,7 +42,7 @@ docker pull jiisanda/docflow:1

## πŸ”Έ Setup Docflow

Follow the steps outlined in the [setup.md](app/docs/setup.md) file
Follow the steps outlined in the [setup.md](app/docs/setup.md) file.

## 🧩 Implementation Detail

Expand Down
4 changes: 0 additions & 4 deletions app/api/routes/auth/auth.py
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,5 @@ async def login(
summary="Get details of currently logged in user"
)
async def get_me(user: TokenData = Depends(get_current_user)):
"""
~TODO: Add an extra db for user profile then return details
For now returning {Userid and Username}
"""

return user
23 changes: 23 additions & 0 deletions app/docs/features/postman.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# πŸ‘¨β€πŸ’» Postman Setup Guide

Explore DocFlow's API endpoints effortlessly using Postman! πŸš€

To access the complete list of API endpoints, visit our [Postman Documentation](https://documenter.getpostman.com/view/20984268/2s9YRGxUcp).

## πŸ“₯ Importing the Collection
Follow these simple steps to import the Postman collection:

1. Click the link.
2. In the top right corner, click Run in Postman.
3. Select Postman for Windows.
4. Import the collection.

Now you're ready to dive into DocFlow's powerful APIs!

## 🌐 Set Up Environment Variable
Configure the environment variable basicUrl with the value localhost:8000. This variable will be used as the base URL for your API requests.

## πŸš€ Try It Out!
With the collection imported and the environment set up, explore DocFlow's features by testing the various endpoints. Get a hands-on experience with the power of DocFlow's API.

Happy testing! If you have any questions or need assistance, feel free to reach out. πŸ“ž

0 comments on commit 1877557

Please sign in to comment.