Junior — Middle
Have you ever created an API specification using Swagger?
sobes.tech AI
Answer from AI
Yes, creating an API specification using Swagger (now known as OpenAPI) is a common practice for documenting RESTful services.
Swagger allows describing the structure of an API — endpoints, methods, parameters, data models — in YAML or JSON format. This makes it easier for developers to understand the API and automates the generation of documentation and client SDKs.
An example of a minimal Swagger specification in YAML format:
openapi: 3.0.0
info:
title: Sample API
version: 1.0.0
paths:
/users:
get:
summary: Get list of users
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: array
items:
type: object
properties:
id:
type: integer
name:
type: string
In Python, libraries such as Flask-RESTPlus, FastAPI (which has built-in support for OpenAPI), or Connexion are often used to work with Swagger, helping to automatically generate specifications from code.