Prev Next

API / Swagger Interview questions

Explain the execution flow of generating server stubs from an OpenAPI document?

Server stub generation mirrors client SDK generation in mechanism — parsing the spec, mapping schemas to types, applying language/framework-specific templates — but the output is routing and controller scaffolding rather than an API-calling client.

flowchart TD A[OpenAPI document] --> B[Parse paths, operations, and schemas] B --> C[Map each operation to a controller method signature] C --> D[Generate routing configuration matching paths/methods] D --> E[Generate request/response model classes] E --> F[Generate method stubs with TODO business logic] F --> G[Developer implements actual business logic inside stubs]

For each operation, the generator creates a method signature with correctly typed parameters (matching the spec's parameter and request body schemas) already wired into the target framework's routing mechanism — a Spring @RestController method with the right @RequestMapping, for instance — but leaves the method body as a stub, usually returning a placeholder or throwing a "not implemented" exception, since business logic is something the spec inherently can't describe.

This is most valuable in a contract-first workflow: the generated stub guarantees the implementation's routes, parameter types, and response shapes stay consistent with the agreed contract from the moment a developer starts filling in logic, rather than the developer manually wiring routing and hoping it matches the spec that other teams are already building against.

What is typically left for a developer to fill in when generating server stubs?
Why is stub generation especially valuable in a contract-first workflow?

More Related questions...

What is Swagger? What is the purpose of Swagger? What is the OpenAPI Specification? What is the difference between Swagger and OpenAPI? What are the key components of Swagger? What is Swagger UI? What is Swagger Editor? What is Swagger Codegen? Define paths in an OpenAPI document? What are operations in OpenAPI? What is a schema in OpenAPI? What are the supported formats for writing an OpenAPI document? What is the purpose of the info object in OpenAPI? What are tags used for in Swagger? List the HTTP methods supported in OpenAPI operations? What is a parameter in OpenAPI, and what are its types? What is a response object in OpenAPI? Describe the components section in OpenAPI 3.0? What is $ref used for in OpenAPI documents? How do you use Swagger annotations in a Java Spring Boot application? What is the difference between OpenAPI 2.0 (Swagger) and OpenAPI 3.0? What is the difference between OpenAPI 3.0 and OpenAPI 3.1? Why is contract-first API design preferred over code-first in some teams? How does Swagger support security schemes like OAuth2 and API keys? What is the difference between springfox and springdoc-openapi? How do you document request and response examples in OpenAPI? Explain how Swagger Codegen generates client SDKs from an OpenAPI spec? What is the difference between path parameters and query parameters? How do you handle polymorphism and discriminators in OpenAPI schemas? Explain the lifecycle of validating an OpenAPI document with a linter like Spectral? When should you use the allOf, oneOf, and anyOf keywords in OpenAPI schemas? How do you version a REST API documented with Swagger? What happens when you click "Try it out" in Swagger UI? How do you split a large OpenAPI specification across multiple files? Explain the internal working of Swagger UI's rendering process? How do you mock an API server using an OpenAPI specification? What is the difference between Swagger and Postman? How do you deprecate an API operation in OpenAPI? Explain the execution flow of generating server stubs from an OpenAPI document? What is the difference between Swagger 2.0's definitions and OpenAPI 3.0's components/schemas? How does content negotiation work in OpenAPI, using the content field? Why doesn't OpenAPI natively describe webhooks before version 3.1? How do you handle authentication in Swagger UI for testing secured endpoints? What is the difference between OpenAPI Generator and the legacy Swagger Codegen? Explain how to enforce validation constraints in an OpenAPI schema? How do you convert a Swagger 2.0 document to OpenAPI 3.0? What is the role of the servers object in OpenAPI 3.0? Explain the internal working of $ref resolution across multiple OpenAPI files? How do you implement contract testing using an OpenAPI specification? Explain the execution flow of API documentation generation in a CI/CD pipeline using Swagger/OpenAPI tooling?
Show more question and Answers...

BigData

Comments & Discussions