Introducing Postapi : Simplifies the process of creating, organizing, and maintaining APIS and It documentations
Documentation is a love letter that you write to your future self. - Damian Conway
Software Engineer, with an insatiable curiosity and passion for problem-solving, sought to enhance my skills and knowledge, but in pursuit of innovation, architecting, and pushing boundaries, that'll emerge over time, always eager to adapt and evolve with the ever-changing landscape of my craft. and wrestling with complex algorithms, and grappling with design dilemmas persevered, armed with their determination, resilience, and a deep-rooted belief in the power of my craft means no bounds, from open source projects, health-related, and fintech.
Team Details
Project Description
Postapi is a Platform that simplifies the process of creating, organizing, and maintaining APIS and supports postman-APIs collections. It helps teams collaborate effectively, improves documentation consistency, and ensures that information is easily accessible to all devs, project managers, and DevOps.
During my systems development process, I mostly work with APIs and Postman as an API Platform for developers to build, and test their APIs, and liked the Postman way of arranging collections and APIs but I could share the collections documentation with dev-ops and frontend guys because they said they don't like the design and documentation process of postman and for the reporting cases.
I choose to build this platform to support along the way where a dev can import Postman collection and keep the documentation consistent and also download the collection in customized design and them in pdf and docx which also help in reports, not only import collection but you can create a brand new collection with postapi and afterward you can export the collection then import it in postman, so the intent is to work hand-in-hand with postman organization process and to solve the problem even better, we can support open-ai (eg: command -> "create a new collection as 'users' and request postapi.com/api/user"), the creation, documentation habits, and maintain of the api become more flexible in system developments.
Well-documented code is crucial for effective collaboration within development teams and there gonna be more features to be added.
Tech Stack
To build this web app I used the following technologies;
Vuejs: (The progressive Javascript Framework)
Pinia (Maintain stores without reloading the page)
cypress (test cases)
Vite (Development server)
Tailwindcss: (UI) (css framework)
Appwrite: (Backend-as-a-service platform that provides developers with all the core APIs)
Authentication: For the process of verifying the identity of a user and ensuring that all transactions, roles, and access are assigned to the right entity.
Auth with Google (OAuth2 provider)
Auth with Github (OAuth2 provider)
Database: serves the most important functions in the postapi and are widely used in various area like maintaining user's imported collection from the postman and concurrent user transactions.
Storage: used to store imported actual files which are mapped to user data and this file can change mostly.
Netlify: (Deployment service)
Challenges I faced during development
There were many difficulties I faced during the development process, some of them:
File Handling: I was working with file handling and as u know javascript doesn't support filesystem handling easily, so I had to figure out the best approach to tackle that without the user getting affected by the instant changes
It was my first time working with Appwrite as backend-service
I do find an excellent design that doesn't have many colors for improving concentration while you're documenting, but I can't say that I did it but am still trying to maintain that, even tho am not a designer.
Public Code Repo
Appwrite - postapi: (https://github.com/manirabona-programer/Appwrite-postapi)
Demo Link
Watch step by step guide of postapi usage.
Conclusion
It's easier to capture and record information while it's fresh in your mind and Documentation should be a living document that evolves with the project.
Ensure that outdated or irrelevant information is removed or revised, is easily accessible and discoverable, Postapi can be a centralized platform base where team members can easily search for and find the relevant information about the projects, To provide Provide clear navigation to enhance usability.
#Appwrite #AppwriteHackathon #Hashnode
Appwrite https://appwrite.io Hashnode https://hashnode.com