Making custom APIs

The Worker Gateway service not only exposes the low-level REST API for invocations but also provides a way to define fully customizable HTTP APIs. Future versions will support other protocols as well such as gRPC or GraphQL.

API Development Workflow

1. Define an API Definition: Learn how to create a new API definition.
2. Register or Upload the API Definition: Register or upload your API definition to the platform.
3. Deploy the API Definition: Deploy your API to make it accessible.
4. Try Out the Deployed API: Test the functionality of your deployed API.
5. Update API Definitions and Deployments: Make changes to existing APIs and redeploy.
6. Set Up API Authentication: Configure authentication mechanisms for your API.
7. Configure CORS for the API Gateway: Set up Cross-Origin Resource Sharing (CORS) policies.
8. Map Responses with Rib: Use Rib for customizing API response mappings.
9. Automatic Documentation for Endpoints: Learn more on automatic spec generation based on Rib scripts.
10. Constraints on Component Updates: Learn more on restrictions for updating components after deployment.
11. Import OpenAPI Specifications: Convert OpenAPI specs into Golem API definitions.
12. Integrate with External API Gateways: Connect your APIs to existing gateways.
13. Troubleshoot Common Issues: Resolve potential problems with your APIs.