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