API References
API documentation for GoEcosystem projects
API References
This page serves as a central hub for all API documentation across GoEcosystem projects. Each project’s API is documented using a consistent format that includes endpoints, parameters, and examples.
Available API Documentation
Go Web Scraper API
RESTful API for accessing and manipulating scraped data programmatically.
- Article and product endpoints
- Pagination and search capabilities
- Data export functionality
Go Utils HTTP API
API for the HTTP client utilities with advanced features.
- Request and response handling
- Middleware support
- Rate limiting and retry mechanics
Go Utils Database API
API for database interaction utilities.
- Connection management
- Query building
- Migration utilities
API Documentation Standards
All API documentation across GoEcosystem follows consistent standards:
Endpoint Documentation
Each endpoint is documented with:
- HTTP method and URL
- Description of functionality
- Request parameters and body schema
- Response status codes and body schema
- Example requests and responses
Error Handling
All APIs use consistent error response formats:
```json { "error": "Error code or type", "message": "Human-readable error message", "details": {} // Optional additional details } ```Standard HTTP status codes are used across all APIs.
Authentication
When required, APIs use:
- API key authentication via headers
- OAuth 2.0 for more complex scenarios
- Rate limiting for all authenticated endpoints
Implementing the API Documentation Template
If you’re adding a new project to GoEcosystem, follow these steps to implement our standardized API documentation:
- Use the Jekyll API layout (
layout: apiin front matter) - Create both a Markdown file (
/docs/api/index.md) and an HTML fallback file (/docs/api/index.html) - Follow the endpoint documentation structure in our template
- Include interactive examples where possible