Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Swagger document different property content for POST and GET requests

Cerrado
  • ¿Algo no está bien?
#8,477 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
45/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Tranquilo
Stack tecnológico
openapi, php
Área
api, documentation

Línea de trabajo

Comienza reproduciendo la salida generada de Swagger/OpenAPI para las operaciones POST y GET en ApiPlatform 3.2, usando el ejemplo PlaceOpportunityUsage y su comportamiento de ApiProperty, Groups y normalización anidada. Rastrea cómo se generan los esquemas de las operaciones y los ejemplos de las propiedades, y verifica después si se pueden representar ejemplos de IRI específicos de la operación y de propiedades anidadas. Se considera terminado cuando se admiten las diferentes salidas de POST/GET o la limitación queda documentada claramente.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

We are using ApiPlatform for 2 years to develop our API. Some properties are (denormalized/normalized) different like on write using IRI reference but on read show nested properties instead.

Even we can update and set the iri reference example on the property like:

class PlaceOpportunityUsage extends AbstractEntityHasId
{ 
/** 
* @var PlaceOpportunity|null 
*/ 
#[ORM\ManyToOne(targetEntity: PlaceOpportunity::class)] 
#[ORM\JoinColumn(referencedColumnName: 'id', nullable: false)] 
#[ApiProperty(example: '/api/opportunities/{id}')] 
#[Groups(['OpportunityUsage:write', 'OpportunityUsage:read'])] 
private ?PlaceOpportunity $opportunity = null;

We think ApiPlatform has feature to automatically set the IRI reference and put to property example without explicitly specify. Also when we set example like that, on each request body/response this property appears as large. But some requests normalizing this property as nested and returns nested object like that:

{ 
"@id": "/api/opportunity/usages/10", 
"@type": "PlaceOpportunityUsage", 
"opportunity": { 
"@id": "/api/instant/opportunities/31", 
"@type": "PlaceOpportunity", 
"status": true, 
"place": { 
"@id": "/api/places/2ffeab17-13d8-458a-abf8-f20d3ba7a08f", 
"@type": "Place", 
"name": "Uncle Wingman", 
"id": "2ffeab17-13d8-458a-abf8-f20d3ba7a08f", 
"createdAt": "2025-07-08", 
"updatedAt": "2026-05-11" 
}, 
"dayInterval": [ 
"MONDAY", 
"TUESDAY", 
"FRIDAY", 
"SATURDAY" 
], 
.... 
}, 
.... 
}

I want to show different examples on POST or GET requests. When I remove the #[ApiProperty] attribute on the property, at this time the request shows that property example as http://example.com, because we couldn't find documentation about iris property in the ApiProperty instance, we tought field for setting reference examples this didn't work.

We are using ApiPlatform 3.2, and we cannot update our version yet.

Is there a way to fix this issue?

Lenguaje dominante
PHP
Estrellas
2.6k
Forks
987
Merge medio
1 d 8 h
PR fusionados (30 d)
80

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de api-platform/core

Todos los issues de api-platform/core

Issues similares

Más issues de PHP

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.