Comprehensive REST API Documentation and Unit Test Overhaul
Budget: €1,500 – €3,000 EUR
Overview:
We are seeking an experienced technical writer and Python developer to migrate and extend our existing API unit tests from Nose to pytest, enhance/rewrite our existing API documentation, and implement the documentation using VitePress with in-browser MiniSearch. We also require that the VitePress doc site includes an overview document with concise natural language descriptions of all endpoints and methods.
Scope of Work:
1. Unit Test Migration:
- Migrate existing unit tests from Nose to pytest.
- Ensure comprehensive test coverage for approximately 15 API endpoints.
2. API Documentation Overhaul:
- Review and extend current API documentation for completeness and accuracy.
- Create engaging, clear, and user-friendly documentation in Markdown.
- Develop an overview document that lists all endpoints and methods with concise natural language descriptions of their purpose and utility.
- Ensure the documentation includes:
-- Consistent Formatting: Standardize the format across all documentation.
-- Clear Headers: Use clear, descriptive headers for each section.
-- Detailed Descriptions: Provide thorough explanations of each endpoint.
-- Extensive Examples: Include multiple examples of requests and responses.
-- Error Handling: Document common errors and their meanings.
-- Consistent Structure and Terminology: Maintain a uniform structure and use consistent terminology.
-- Metadata and Annotations: Add metadata or annotations where necessary to aid understanding.
3. VitePress Implementation:
- Set up VitePress for documentation, including versioning.
- Implement in-browser MiniSearch for documentation search functionality.
4. Template Customization:
- Use a standard API documentation template.
- Potential for future design customization.
Deliverables:
- Unit Tests: Fully migrated and updated unit tests using pytest, delivered either as a new Git repository or as a new branch in the existing test repository.
- API Documentation: Comprehensive and engaging API documentation in Markdown format.
- Overview Document: An overview document with concise descriptions of all endpoints and methods.
- VitePress Setup: A Git repository containing the VitePress setup with:
-- All necessary dependencies defined.
-- The VitePress site structure.
-- Markdown files with the complete documentation.
-- Instructions (in README.md) on how to install and run VitePress to generate the documentation site.
Ideal Skills and Experience:
- Proficiency in Python
- Strong prior experience in creating user-friendly REST API documentation
- Strong understanding of Markdown and its application in technical writing
- Extensive experience in unit testing, preferably in a REST API context
Automated bids or bids not in-line with the requirements will be ignored. So please write something to demonstrate that you read and understood this project description and showcase your relevant experience when you make a bid. Further details can be discussed in direct message.
We are seeking an experienced technical writer and Python developer to migrate and extend our existing API unit tests from Nose to pytest, enhance/rewrite our existing API documentation, and implement the documentation using VitePress with in-browser MiniSearch. We also require that the VitePress doc site includes an overview document with concise natural language descriptions of all endpoints and methods.
Scope of Work:
1. Unit Test Migration:
- Migrate existing unit tests from Nose to pytest.
- Ensure comprehensive test coverage for approximately 15 API endpoints.
2. API Documentation Overhaul:
- Review and extend current API documentation for completeness and accuracy.
- Create engaging, clear, and user-friendly documentation in Markdown.
- Develop an overview document that lists all endpoints and methods with concise natural language descriptions of their purpose and utility.
- Ensure the documentation includes:
-- Consistent Formatting: Standardize the format across all documentation.
-- Clear Headers: Use clear, descriptive headers for each section.
-- Detailed Descriptions: Provide thorough explanations of each endpoint.
-- Extensive Examples: Include multiple examples of requests and responses.
-- Error Handling: Document common errors and their meanings.
-- Consistent Structure and Terminology: Maintain a uniform structure and use consistent terminology.
-- Metadata and Annotations: Add metadata or annotations where necessary to aid understanding.
3. VitePress Implementation:
- Set up VitePress for documentation, including versioning.
- Implement in-browser MiniSearch for documentation search functionality.
4. Template Customization:
- Use a standard API documentation template.
- Potential for future design customization.
Deliverables:
- Unit Tests: Fully migrated and updated unit tests using pytest, delivered either as a new Git repository or as a new branch in the existing test repository.
- API Documentation: Comprehensive and engaging API documentation in Markdown format.
- Overview Document: An overview document with concise descriptions of all endpoints and methods.
- VitePress Setup: A Git repository containing the VitePress setup with:
-- All necessary dependencies defined.
-- The VitePress site structure.
-- Markdown files with the complete documentation.
-- Instructions (in README.md) on how to install and run VitePress to generate the documentation site.
Ideal Skills and Experience:
- Proficiency in Python
- Strong prior experience in creating user-friendly REST API documentation
- Strong understanding of Markdown and its application in technical writing
- Extensive experience in unit testing, preferably in a REST API context
Automated bids or bids not in-line with the requirements will be ignored. So please write something to demonstrate that you read and understood this project description and showcase your relevant experience when you make a bid. Further details can be discussed in direct message.