Write Spec and Generate Code Instantly with Zero Configs
1. Write Spec in the Browser with Code Completion
2. View Beautiful Documentation
3. Generate Code Instantly with Zero Configuration
What Makes it YIZY?
Schema First Design
Tailored for Schema First API Design, Decoupling Frontend and Backend
E2E Type Safety
Request and Response Model Generation for Server and Client
Blazingly Fast Code Genenration
Instant Code Generation with Zero Configuration
Language Agnostic
Multi-Language Support
Aggressively Simple
POST Request Under the Hood
Open API Spec Support
Generate Open API Spec for Tool Chain Support
FAQ
No. YIZY API is an opinionated style of building Json API that deviates from Restful
practices. Here is the YIZY API Convention.
- Use 'Action' instead of 'Resource' in url. Eg. /getUserById instead of /user/{id}
- Endpoints must only accept POST request with content type application/json.
- Endpoints must reply with a status code of 200 unless there is a network error
- Inputs to the endpoint should be transferred in POST request body. Configuration values such as API keys can be optionally supplied in request headers. Parameters in url are not allowed.
- All response body should include a nullable error object as well as a nullable result object.