Task 02 API Mismatch Detection Practice Guide
📥 Practice Input
- •
day4_api_specification_v1.md(Statement of mixed use of terms)
💾 Practice output (Output)
- •
project-glossary.md(Standard Glossary)
1. Story and practice background
Late in the project, a strange conversation occurs during a bug review meeting. The planner said, "An error occurred on the customer withdrawal screen," and the API developer said, "The rating (star_rating) field, which is an expert list card UI element, is missing from the API response specifications. A member referential integrity error occurred when processing delete from the DB." The publisher said, "On the admin page, it says customer company."
In this way, if different terms are used for a single business domain in the plan (member), API specification (the rating (star_rating) field, which is an expert list card UI element, is omitted from the API response specification), front screen (customer), and DB table (member), communication costs between developers are amplified and it becomes a hotbed for code rework.
In this exercise, you will use Codex to fully investigate the state of fragmentation of terms scattered throughout the entire project document, and learn techniques for building a standardized terminology dictionary that covers everything from planning to DB variable names.
2. Learning objectives
- The fragmentation status of domain-specific terms used in documents and design specifications can be identified.
- You can define the project detection area and English abbreviation (domain standard name).
- A dictionary of standard terms to be commonly followed by planners, developers, and designers can be defined.
- Using AI, you can map legacy words to variable names and data types.
🛠️Practical guide to follow along
- Create file for practice: Click the download buttons below to download the planning document and draft API specification.
automation/Save it within the folder. - Codex standardization mandate: Build by sending the **Codex request prompt** below to the Codex Client prompt input window.
- Vocabulary Dictionary Review: Check whether the fragmented terms in the generated dictionary are accurately mapped to the detection area, English standard name, and DB recommended column name.
Download practice materials (3 Files)
Codex request prompt
Task 02 Prompt
Please cross-check the provided day4_requirements.md, day4_screen_definition.md, and day4_api_specification_v1.md files to find any API endpoints and fields that are inconsistent or missing from the planning requirements or screen UI design and create a review report.
4. Example results
Codex comprehensively analyzes multiple terms to derive a normalized master dictionary as follows:
| detection area | Detailed discrepancies/omissions | data type | Existing mixed words | Recommended Action |
|---|---|---|---|---|
| missing field | Expert list card UI element, rating (star_rating) field is missing from API Response specification | VARCHAR(50) | High, the expert list card UI element star_rating field is missing from the API Response specification | Request to add star_rating to GET /api/v1/experts API response data |
| Endpoint missing | The plan describes the agent reservation approval function, but the backend API specification lacks an approval status change API. | VARCHAR(50) | Critical (High), the plan describes the agent reservation approval function, but the backend API specification lacks an approval status change API. | PATCH /api/v1/reservations/{id}/status New API design required |
| Consultation reservation | Reservation | VARCHAR(50) | Reservation, application, Book, Reservation | reservation_id |
| Reservation status | ReservationStatus | VARCHAR(20) | Status, Category, Step, Status | res_status |