apiblaze 0.20.39 → 0.20.43
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +13 -6
- package/dist/index.js +1457 -897
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -30,12 +30,17 @@ Prefer commands? A few one-liners:
|
|
|
30
30
|
# Chat with your API
|
|
31
31
|
npx apiblaze apichat --openapi https://apiblaze.com/pokeapi_openapi.yaml
|
|
32
32
|
|
|
33
|
-
# Make an API in one line — no account needed (prints a claim URL)
|
|
33
|
+
# Make an API in one line — no account needed (prints a claim URL).
|
|
34
|
+
# By default callers sign in with GitHub (APIblaze-hosted); add --apikey for an API-key door.
|
|
34
35
|
npx apiblaze create --target https://api.example.com
|
|
35
36
|
|
|
36
37
|
# Or build it straight from an OpenAPI spec — a URL or a local file.
|
|
37
|
-
# The routes, the API version and one environment per `servers` entry all come from the spec
|
|
38
|
-
|
|
38
|
+
# The routes, the API version and one environment per `servers` entry all come from the spec,
|
|
39
|
+
# and you're asked which resources to lock to the person who created them (e.g. /reservations).
|
|
40
|
+
npx apiblaze create --target https://petstore3.swagger.io/api/v3/openapi.json
|
|
41
|
+
|
|
42
|
+
# Same thing with zero prompts: GitHub sign-in, every lockable resource locked.
|
|
43
|
+
npx apiblaze create --target ./openapi.yaml --auto
|
|
39
44
|
|
|
40
45
|
# Configure how your backend is accessed through the proxy
|
|
41
46
|
npx apiblaze config
|
|
@@ -117,8 +122,8 @@ Every chat turn shows its cost.
|
|
|
117
122
|
|
|
118
123
|
| Command | What it does |
|
|
119
124
|
|---|---|
|
|
120
|
-
| `apiblaze create --target <url>` | Make an API from a backend (no account needed) |
|
|
121
|
-
| `apiblaze create --
|
|
125
|
+
| `apiblaze create --target <url>` | Make an API from a backend (no account needed). Callers sign in with GitHub by default; `--apikey` for an API-key door |
|
|
126
|
+
| `apiblaze create --target <file\|url>` | Make an API from an OpenAPI spec — a local file or a spec URL. Asks which resources to lock to their creator; `--auto` locks them all |
|
|
122
127
|
| `apiblaze sidecar` | Route a Next.js app's external `fetch()` calls through APIblaze (one command) |
|
|
123
128
|
| `apiblaze dev [port]` | Put your localhost behind a public URL |
|
|
124
129
|
| `apiblaze login` / `logout` | Sign in / out (logout asks producer or consumer) |
|
|
@@ -147,7 +152,9 @@ Every chat turn shows its cost.
|
|
|
147
152
|
| `apiblaze group create / list / delete <name>` | Manage a tenant's groups (also `<UsersGroupsWidget/>`) |
|
|
148
153
|
| `apiblaze group add-user / remove-user <user> <group>` | Put a user in a group (or take them out) |
|
|
149
154
|
| `apiblaze group add-group / remove-group <child> <parent>` | Nest a group inside a group |
|
|
150
|
-
| `apiblaze rule
|
|
155
|
+
| `apiblaze rule <project> [--enforce]` | Lock the spec's resources to the person who created them (or an admin) — tick what to lock, save, turn on |
|
|
156
|
+
| `apiblaze rule <project> "<plain english>"` | Describe any other access rule in one shot (billed per turn; shadow, then `--enforce`) |
|
|
157
|
+
| `apiblaze config <project> authorization.enforce_authorization false` | Turn the rules off (they stay saved) |
|
|
151
158
|
| `apiblaze agent authz <project>` | Design & turn on authorization interactively (chat) |
|
|
152
159
|
|
|
153
160
|
### Producer — change a proxy's config
|