From 187755792fd9ebb066633d91f950023f93fae524 Mon Sep 17 00:00:00 2001 From: jiisanda Date: Sun, 31 Dec 2023 17:57:52 +0530 Subject: [PATCH] =?UTF-8?q?=F0=9F=99=86=E2=80=8D=E2=99=82=EF=B8=8F=20postm?= =?UTF-8?q?an=20setup=20guide?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 4 +++- app/api/routes/auth/auth.py | 4 ---- app/docs/features/postman.md | 23 +++++++++++++++++++++++ 3 files changed, 26 insertions(+), 5 deletions(-) create mode 100644 app/docs/features/postman.md diff --git a/README.md b/README.md index 247a3f7..e757cd8 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 diff --git a/app/api/routes/auth/auth.py b/app/api/routes/auth/auth.py index 3a22031..128b789 100644 --- a/app/api/routes/auth/auth.py +++ b/app/api/routes/auth/auth.py @@ -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 diff --git a/app/docs/features/postman.md b/app/docs/features/postman.md new file mode 100644 index 0000000..915d2dd --- /dev/null +++ b/app/docs/features/postman.md @@ -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. 📞 \ No newline at end of file