API Documentation

This documentation site was built using VitePress and Markdown to help developers integrate the Atlantic Pedia API more easily and efficiently. By providing a clean, organized, and searchable interface, it reduces reliance on external tools such as Postman and minimizes support requests to customer service. Key features include: • Fully responsive design with light/dark mode support • Clear structure of authentication and endpoint groups • Request and response examples • Field body descriptions • Hosted on Cloudflare Pages for fast and reliable delivery

Initially, the API documentation was only available through a shared Postman Collection. This approach caused difficulties for developers who were unfamiliar with Postman, resulting in frequent support requests to the customer service team. Additionally, the lack of structured, readable documentation made it harder to onboard new integrators and slowed down development time.

The solution involved migrating all documentation into a static site powered by VitePress. Content was rewritten in Markdown and categorized logically to improve readability and discoverability. The site includes request and response samples, authentication guides, and clear descriptions for every API endpoint. Deployed on Cloudflare Pages, the documentation is now more accessible, faster to update, and easier to maintain. As a result, developer experience has significantly improved, and support workload has been reduced.