ApprovedEngineeringapifrontend
API spec change summary for front-end developers
PL by Prompier Library
☆☆☆☆☆ New
Version 1 · updated Nov 10, 2026
Reviewed by moderator Prompier Library on Nov 10, 2026. Checked for personal data, secrets, risky instructions and a clear license.
About this prompt
Compares an old and new API specification and writes a front-end focused change summary with breaking changes, new fields and migration steps. Use when a backend team ships a new spec version.
Prompt text
You are a developer who bridges backend and front-end teams. Compare two versions of an API specification and explain what the front-end must do.
Inputs:
- Old specification (or the relevant part): {{old_spec}}
- New specification: {{new_spec}}
- Front-end areas affected, if known (pages, features): {{frontend_areas}}
- Language or framework used on the front end: {{frontend_stack}}
Steps:
1. Parse both specs and list every difference at endpoint level: added, removed, renamed, and changed. If a spec looks truncated, say so and ask up to 3 questions; otherwise proceed.
2. Classify each change as Breaking (removed or renamed field, new required input, type change, stricter validation, changed status code), Additive (new optional field or endpoint), or Cosmetic (descriptions only).
3. For breaking changes, describe what would fail in a typical client and the exact change needed, using short before and after snippets in the stack I named.
4. Note new capabilities the front end could use.
5. Note what you could not determine from the specs (behavior, defaults, authentication changes) and who to ask.
Output format:
- Headline: number of breaking, additive and cosmetic changes.
- Table: endpoint | change | class | front-end action.
- Migration checklist ordered by risk.
- Questions for the backend team.
Quality bar: report only differences actually present in the text, do not guess how the server behaves, keep snippets minimal, and put breaking changes first.
Variables
4 variables| Variable | What to enter | Example | Default |
|---|---|---|---|
| {{old_spec}} | Paste the old specification, or the relevant part | paths: /users/{id}: get: responses: 200: name, email... | — |
| {{new_spec}} | Paste the new specification | paths: /users/{id}: get: responses: 200: full_name, email, avatar_url... | — |
| {{frontend_areas}} | Pages or features likely affected, if you know | Profile page and the team members list | — |
| {{frontend_stack}} | Language or framework used on the front end | React with TypeScript | — |
Try it
Live previewPaste the old specification, or the relevant part
Paste the new specification
Pages or features likely affected, if you know
Language or framework used on the front end
Your finished prompt
You are a developer who bridges backend and front-end teams. Compare two versions of an API specification and explain what the front-end must do.
Inputs:
- Old specification (or the relevant part): {{old_spec}}
- New specification: {{new_spec}}
- Front-end areas affected, if known (pages, features): {{frontend_areas}}
- Language or framework used on the front end: {{frontend_stack}}
Steps:
1. Parse both specs and list every difference at endpoint level: added, removed, renamed, and changed. If a spec looks truncated, say so and ask up to 3 questions; otherwise proceed.
2. Classify each change as Breaking (removed or renamed field, new required input, type change, stricter validation, changed status code), Additive (new optional field or endpoint), or Cosmetic (descriptions only).
3. For breaking changes, describe what would fail in a typical client and the exact change needed, using short before and after snippets in the stack I named.
4. Note new capabilities the front end could use.
5. Note what you could not determine from the specs (behavior, defaults, authentication changes) and who to ask.
Output format:
- Headline: number of breaking, additive and cosmetic changes.
- Table: endpoint | change | class | front-end action.
- Migration checklist ordered by risk.
- Questions for the backend team.
Quality bar: report only differences actually present in the text, do not guess how the server behaves, keep snippets minimal, and put breaking changes first.
Sample output
Headline: 2 breaking, 3 additive, 1 cosmetic.
Endpoint | Change | Class | Front-end action
GET /orders | field total renamed to totalAmount | Breaking | Update list view and sorting keys
POST /orders | new required field currency | Breaking | Add currency to the checkout payload
GET /orders/{id} | new optional field trackingUrl | Additive | Optionally show a tracking link
Migration checklist
1. Rename total in the order types and mappers.
2. Send currency on create (default to the account currency).
Questions for backend: is the old total field kept for a deprecation period?
An example the author shared. Your result will differ.
Reviews
No written reviews yet. If you have used this prompt, tell others how it went.
0 forks
Public forks of “API spec change summary for front-end developers” by Prompier Library (v1).
Lineage: Original prompt → this prompt → 0 forks
No forks have been shared publicly yet.