Chimoney API documentation overview

This project documents key parts of the Chimoney REST API including:

• A Getting started section
• Two endpoints written in Markdown: Verify a payment and Generate invoice with AI
• An endpoint rendered using the docusaurus open-api plugin

About Chimoney

Chimoney is a fintech platform that allows for efficient payments across borders, multi-currency wallets and global payouts. For more information, see the Chimoney website.

Improvements

1. Improved onboarding: The actual Getting started page seems like a simple guide that talks about products that can be built with the API. I restructured it into something more hands-on, including:

   • How to create an account
   • Authentication
   • The base URL
   • A sample Postman request

2. Structured endpoint pages:: Created pages for two endpoints implementing proper structure and codeblocks for displaying responses.

3. Rendered an endpoint using a plugin: I documented an endpoint using the YAML format and rendered it using the docusaurus open-api plugin. The following image is a screenshot of the YAML file.

Challenges

• Getting an API key on the Chimoney sandbox was confusing initially.

Key takeaways

• I learnt how to test API endpoints with postman.
• I learnt how to interpret OpenAPI specification

Tools & tech stack used

Tool / Technology	Purpose
YAML	The format for writing OpenAPI specification
Swagger Editor	Writing OpenAPI specification
Postman	For testing API endpoints
Docusaurus OpenAPI plugin	For rendering the YAML file