Zakaria/floci-ui
1
0
Fork 0
Code Issues 1 Pull Requests 1 Actions Packages Projects Releases Wiki Activity

feat(api): add HTTP and WebSocket APIs (API Gateway v2) to the API Gateway page
CI / checks (pull_request) Successful in 26m49s
Details

Browse Source 
API Gateway v2 is a separate AWS API from REST APIs, so HTTP and WebSocket APIs
made with the SDK, SAM, CDK or Terraform never showed up. The API Gateway page
now lists all three kinds with a Type column, creates each from the same form,
and opens HTTP and WebSocket APIs in their own panel:

- Quick create: an HTTP API with a Lambda gets a catch-all route on an
  auto-deployed $default stage, plus the Lambda permission.
- Routes to Lambda (payload 2.0) or HTTP backends; deleting a route removes
  the integration and Lambda permission only it used.
- Stages with or without automatic deployment, and deploy on demand.
- JWT authorizers filled in from a Cognito pool's OpenID Connect discovery
  document and an app client, or from any issuer; protect routes with them.
- CORS configuration.
- A tester that sends a real request to a stage, and for WebSocket APIs one
  that connects, sends a message and collects the replies.

Capabilities are advertised under a new httpApiActions group, covered by the
cloudProxy guard test. Verified end to end against TheCloud's runtime.
This commit is contained in:
Zakaria
2026-10-25 09:18:50 -04:00
parent 6acd3656a1
commit bb5ca85a88
22 changed files with 2410 additions and 68 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/api/src/cloud-spi/apigatewaySchema.ts
+62 -5
View File
@@ -1,4 +1,4 @@
import type {CapabilitySchema, ResourceActionName, ServiceSchema} from './types'
import type {CapabilitySchema, HttpApiActionName, ResourceActionName, ServiceSchema} from './types'
const resourceActions: CapabilitySchema<ResourceActionName>[] = [
{name: 'list', label: 'List APIs', enabled: true, status: 'available', runtimeRequired: true},
@@ -7,12 +7,42 @@ const resourceActions: CapabilitySchema<ResourceActionName>[] = [
{name: 'inspect', label: 'Inspect API', enabled: true, status: 'available', runtimeRequired: false},
]
const httpApiActions: CapabilitySchema<HttpApiActionName>[] = [
{name: 'describe', label: 'Show routes, stages and authorizers', enabled: true, status: 'available', runtimeRequired: true},
{name: 'createRoute', label: 'Add a route', enabled: true, status: 'available', runtimeRequired: true},
{name: 'deleteRoute', label: 'Delete a route', enabled: true, status: 'available', runtimeRequired: true},
{name: 'setRouteAuthorizer', label: 'Protect a route with an authorizer', enabled: true, status: 'available', runtimeRequired: true},
{name: 'createStage', label: 'Add a stage', enabled: true, status: 'available', runtimeRequired: true},
{name: 'deleteStage', label: 'Delete a stage', enabled: true, status: 'available', runtimeRequired: true},
{name: 'deploy', label: 'Deploy to a stage', enabled: true, status: 'available', runtimeRequired: true},
{name: 'createAuthorizer', label: 'Add a JWT authorizer', enabled: true, status: 'available', runtimeRequired: true},
{name: 'deleteAuthorizer', label: 'Delete an authorizer', enabled: true, status: 'available', runtimeRequired: true},
{name: 'updateCors', label: 'Configure CORS', enabled: true, status: 'available', runtimeRequired: true},
{name: 'sendRequest', label: 'Send a request to a stage', enabled: true, status: 'available', runtimeRequired: true},
{name: 'testWebSocket', label: 'Connect and send a WebSocket message', enabled: true, status: 'available', runtimeRequired: true},
]
const httpOnly = {field: 'protocol', values: ['HTTP']}
const webSocketOnly = {field: 'protocol', values: ['WEBSOCKET']}
export function awsApiGatewaySchema(): ServiceSchema {
return {
cloud: 'aws',
service: 'apigateway',
displayName: 'AWS API Gateway',
fields: [
{
name: 'protocol',
label: 'API type',
type: 'select',
required: true,
defaultValue: 'REST',
options: [
{label: 'REST API (resources, methods and stages)', value: 'REST'},
{label: 'HTTP API (routes to Lambda or HTTP backends, JWT authorizers)', value: 'HTTP'},
{label: 'WebSocket API (two-way messages routed to Lambda)', value: 'WEBSOCKET'},
],
},
{
name: 'name',
label: 'API Name',
@@ -30,20 +60,47 @@ export function awsApiGatewaySchema(): ServiceSchema {
label: 'Description',
type: 'text',
required: false,
description: 'Optional description for the REST API.',
description: 'Optional description for the API.',
validation: {
maxLength: 1024,
message: 'Description must be 1024 characters or fewer.',
},
},
{
name: 'functionName',
label: 'Lambda function',
type: 'text',
required: false,
visibleWhen: httpOnly,
description: 'Optional. Sends every request to this function through a catch-all route, on a $default stage that deploys automatically. Leave empty to add routes yourself.',
},
{
name: 'routeSelectionExpression',
label: 'Route selection expression',
type: 'text',
required: false,
defaultValue: '$request.body.action',
visibleWhen: webSocketOnly,
description: 'Which field of each message picks its route. With $request.body.action, {"action": "sendMessage"} goes to the sendMessage route.',
},
{
name: 'stageName',
label: 'Stage',
type: 'text',
required: false,
defaultValue: 'dev',
visibleWhen: webSocketOnly,
description: 'Created with automatic deployment, so route changes go live right away.',
validation: {pattern: '^[A-Za-z0-9_-]{1,128}$', message: 'Use letters, numbers, hyphens and underscores'},
},
],
actions: ['list', 'create', 'delete', 'inspect'],
capabilities: {resourceActions},
capabilities: {resourceActions, httpApiActions},
filters: [{name: 'search', label: 'Search', type: 'text', required: false}],
columns: [
{name: 'name', label: 'API Name'},
{name: 'type', label: 'Type'},
{name: 'createdAt', label: 'Created At'},
{name: 'protocol', label: 'Type', path: 'metadata.protocol', format: 'badge'},
{name: 'createdAt', label: 'Created At', format: 'relative'},
],
}
}