OpenAPI Reviewer-OpenAPI/Swagger Validation

Example

Ensuring resource names like 'users' or 'orders' are used instead of singular forms like 'user' or 'order'.

Scenario

In a user management system, an endpoint defined as '/user' for listing users would be flagged for correction to '/users' to reflect that it handles a collection of users.

Example

Identifying incorrect use of the POST method for updating resources, suggesting PUT or PATCH instead.

Scenario

An API with an endpoint '/products/{id}' using POST for updates would receive guidance to use PUT for full updates or PATCH for partial updates.

Example

Checking for logical and hierarchical organization of endpoints, such as '/users/{userId}/orders' for a user's orders.

Scenario

A shopping cart API with a flat structure like '/getUserOrders' would be advised to adopt a more hierarchical structure reflecting resource relationships.

Example

Ensuring that endpoints return appropriate status codes, such as 404 for not found resources or 201 for created resources.

Scenario

An API that returns a 200 OK status for a failed resource creation due to invalid input would be corrected to return a 400 Bad Request or 422 Unprocessable Entity.

Example

Validating the structure and content of request and response bodies to ensure they meet the expected format.

Scenario

If a 'create user' endpoint's request body lacks essential fields like 'email', OpenAPI Reviewer would highlight this omission for correction.