API Documentation
API Documentation
This section contains comprehensive API documentation for all language implementations.
Available Languages
Rust
Cargo-generated documentation with rustdoc
Python
Sphinx-generated documentation with autodoc
Node.js
JSDoc-generated documentation
PHP
phpDocumentor-generated documentation
Bash
Manual documentation for shell scripts
Common API Endpoints
All server implementations provide these common endpoints:
Greeting Endpoints
GET /
- Generate greeting with query parametersGET /greet
- Same as root endpoint
Parameters:
name
(string, optional) - Name to greet (default: “World”)language
(string, optional) - Language code (default: “en”)
System Endpoints
GET /health
- Health check and system informationGET /languages
- List available languagesGET /languages/{language}
- Get information about specific language
Response Format
All endpoints return JSON responses with consistent structure:
{
"message": "Hello, World!",
"name": "World",
"language": "en",
"timestamp": "2024-01-01T00:00:00Z",
"server": "Language/Framework"
}
Supported Languages
All implementations support these languages:
- English (en)
- Spanish (es)
- French (fr)
- German (de)
- Italian (it)
- Portuguese (pt)
- Russian (ru)
- Japanese (ja)
- Chinese (zh)