Snail API (1.0.0)
Download OpenAPI specification:Download
A simple snail API for interacting with snail images and information.
Response samples
- 200
Content type
application/json
Example
{- "id": 1,
- "date": "2024-09-30",
}
List snail images
Return a list of snail images.
query Parameters
| startDate | string <date> Example: startDate=2023-02-23 The starting date to retrieve future operating hours from. Defaults to today's date. |
| endDate | string <date> Example: endDate=2023-04-18 The end of a date range to retrieve special events for. Defaults to 7 days after |
| page | integer Default: 1 Example: page=2 The page number to retrieve. |
| limit | integer <= 30 Default: 10 Example: limit=15 The number of data per page. |
Responses
Response samples
- 200
Content type
application/json
Example
[
]
Response samples
- 200
Content type
application/json
[- {
- "id": 1,
- "date": "2024-09-30",
- "category": "Property",
- "content": "A snail eats..."
}, - {
- "id": 2,
- "date": "2024-10-22",
- "category": "Lissachatina fulica",
- "content": "Lissachatina fulica is a species of large land snail..."
}
]Register a snail information
Request Body schema: application/jsonrequired
| category required | string (InfoCategory) Category of informations |
| content required | string (InfoContent) Category of informations |
Responses
Request samples
- Payload
Content type
application/json
{- "category": "Property",
- "content": "A snail eats ..."
}Response samples
- 200
Content type
application/json
{- "id": 1,
- "date": "2024-09-30",
- "category": "Property",
- "content": "A snail eats ..."
}Response samples
- 200
Content type
application/json
{- "value": {
- "title": "Introduce the snail API",
- "content": "Welcome the snail API",
- "environment": {
- "platform": "Serverless architecture",
- "compute": "AWS Lambda",
- "api": "API Gateway",
- "database": "DynamoDB",
- "storage": "Amazon S3"
}
}
}