Cómo crear un mock server con Prism CLI
Contenido del curso
cristhian joel Acevedo Tipian
Miguel Angel Reyes Moreno
Omar Lorenzana Rodriguez
Ruben Alejandro Ramirez
Diego Jesús Bolaños Suárez
por eso se necesita el archivo openapi.yaml
Lo puedes hacer tú mismo y pedirselo a la IA para practicar, no estás forzado a usar el de la clase
probablemente usar sudo
sudo will force it through, sure, but giving root privileges to global npm packages can haunt your file permissions later.
A cleaner fix is running it directly with npx @stoplight/prism-cli without a global install at all, completely dodging the permission wall. Have you tested that approach?
openapi: 3.1.1 info: title: API Firs description: A sample API to illustrate OpenAPI concepts version: 1.0.0 servers: - url: http://localhost:3000/v1 description: Local server - url: http://localhost:3000/v2 description: Production server components: schemas: HelloResponse: type: object Product: type: object required: - id - name - price - category properties: id: type: integer minimum: 1 name: type: string minLength: 2 maxLength: 40 description: type: string maxLength: 500 price: type: number minimum: 0 multipleOf: 0.01 category: type: string enum: [electronics, books, clothes, food] tags: type: array items: type: string minItems: 1 inStock: type: boolean specifications: type: object additionalProperties: type: string ratings: type: array items: type: object required: - score - comment properties: score: type: integer minimum: 1 maximum: 5 comment: type: string maxLength: 200 ProductInput: type: object required: - name - price - category properties: name: type: string minLength: 2 maxLength: 40 description: type: string maxLength: 500 price: type: number minimum: 0 multipleOf: 0.01 category: type: string enum: [electronics, books, clothes, food] tags: type: array items: type: string minItems: 1 inStock: type: boolean specifications: type: object additionalProperties: type: string ratings: type: array items: type: object required: - score - comment properties: score: type: integer minimum: 1 maximum: 5 comment: type: string maxLength: 200 ProductUpdate: type: object minProperties: 1 properties: name: type: string minLength: 2 maxLength: 40 description: type: string maxLength: 500 price: type: number minimum: 0 multipleOf: 0.01 category: type: string enum: [electronics, books, clothes, food] tags: type: array items: type: string minItems: 1 inStock: type: boolean specifications: type: object additionalProperties: type: string ratings: type: array items: type: object required: - score - comment properties: score: type: integer minimum: 1 maximum: 5 comment: type: string maxLength: 200 ErrorResponse: type: object required: - message properties: message: type: string paths: /hello: get: summary: Hola Mundo responses: '200': description: A successful response content: application/json: schema: $ref: '#/components/schemas/HelloResponse' /aprendiendo: get: summary: Aprendiendo API First responses: '200': description: A successful response content: application/json: schema: type: object /users: post: summary: Create a new user requestBody: required: true content: application/json: schema: type: object required: - name - email - age properties: name: type: string minLength: 2 email: type: string format: email age: type: integer minimum: 18 responses: '201': description: User created successfully content: application/json: schema: type: object properties: id: type: string name: type: string email: type: string format: email age: type: integer /users/{id}: get: summary: Get user by ID parameters: - in: path name: id required: true schema: type: integer responses: '200': description: User found content: application/json: schema: type: object properties: id: type: integer name: type: string '404': description: User not found content: application/json: schema: type: object properties: message: type: string post: summary: update user's name by ID parameters: - in: path name: id required: true schema: type: integer requestBody: required: true content: application/json: schema: type: object required: - name - age - email properties: name: type: string minLength: 2 age: type: integer minimum: 18 email: type: string format: email responses: '200': description: User updated successfully content: application/json: schema: type: object properties: id: type: integer name: type: string age: type: integer email: type: string '404': description: User not found content: application/json: schema: type: object properties: message: type: string /products: get: summary: Get all products responses: '200': description: Product list content: application/json: schema: type: array items: $ref: '#/components/schemas/Product' post: summary: Create a new product requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ProductInput' responses: '201': description: Product created successfully content: application/json: schema: $ref: '#/components/schemas/Product' '400': description: Invalid product data content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' /products/{id}: get: summary: Get product by ID parameters: - in: path name: id required: true schema: type: integer minimum: 1 responses: '200': description: Product found content: application/json: schema: $ref: '#/components/schemas/Product' '404': description: Product not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' put: summary: Replace product by ID parameters: - in: path name: id required: true schema: type: integer minimum: 1 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ProductInput' responses: '200': description: Product replaced successfully content: application/json: schema: $ref: '#/components/schemas/Product' '400': description: Invalid product data content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Product not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' patch: summary: Update product by ID parameters: - in: path name: id required: true schema: type: integer minimum: 1 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ProductUpdate' responses: '200': description: Product updated successfully content: application/json: schema: $ref: '#/components/schemas/Product' '400': description: Invalid product data content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Product not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' delete: summary: Delete product by ID parameters: - in: path name: id required: true schema: type: integer minimum: 1 responses: '204': description: Product deleted successfully '404': description: Product not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse'
openapi: 3.0.0
info:
title: API First Example
version: 1.0.0
description: An example API using OpenAPI 3.0
servers:
- url: http://localhost:3000/v1
description: Version 1 de la API
- url: http://localhost:3000/v2
description: Version 2 de la API
components:
schemas:
HelloResponse:
type: object
# Esquema reutilizable de Producto
Product:
type: object
required:
- id
- name
- description
- price
properties:
id:
type: string
example: 123
name:
type: string
example: Product Name
maxLength: 200
description:
type: string
example: Product Description
maxLength: 500
price:
type: number
format: float
example: 99.99
minimum: 0
category:
type: string
enum:
- Electronics
- Clothing
- Home
- Sports
- Toys
tags:
type: array
items:
type: string
minimum: 1
example: ["tag1", "tag2"]
inStock:
type: boolean
example: true
specifications:
type: object
additionalProperties:
type: string
example:
color: "red"
size: "M"
warranty: "2 years"
rating:
type: array
items:
type: object
required:
- score
- comment
properties:
score:
type: integer
example: 5
minimum: 0
maximum: 5
comment:
type: string
maxLength: 500
example: "Great product!"
paths:
/hello:
get:
summary: Say hello
responses:
'200':
description: A hello message
content:
application/json:
schema:
$ref: '#/components/schemas/HelloResponse'
/users:
get:
summary: Obtener todos los usuarios
responses:
'200':
description: Lista de usuarios
content:
application/json:
schema:
type: array
items:
type: object
properties:
id:
type: string
example: 123
name:
type: string
example: John Doe
email:
type: string
format: email
example:
post:
summary: Crear un nuevo usuario
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- id
- name
properties:
id:
type: string
example: 123
name:
type: string
example: John Doe
minLength: 2
email:
type: string
format: email
example:
minLength: 5
responses:
'201':
description: Usuario creado
content:
application/json:
schema:
type: object
properties:
id:
type: string
example: 123
name:
type: string
example: John Doe
email:
type: string
format: email
example:
/users/{id}:
get:
summary: Obtener un usuario por ID
parameters:
- in: path
name: id
required: true
schema:
type: string
responses:
'200':
description: Usuario encontrado
content:
application/json:
schema:
type: object
properties:
id:
type: string
example: 123
name:
type: string
example: John Doe
email:
type: string
format: email
example:
'404':
description: Usuario no encontrado
content:
application/json:
schema:
type: object
properties:
message:
type: string
put:
summary: Actualizar un usuario por ID
parameters:
- in: path
name: id
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
example: John Doe
email:
type: string
format: email
example:
responses:
'200':
description: Usuario actualizado
content:
application/json:
schema:
type: object
properties:
id:
type: string
example: 123
name:
type: string
example: John Doe
email:
type: string
format: email
example:
'404':
description: Usuario no encontrado
content:
application/json:
schema:
type: object
properties:
message:
type: string
