0
303
Views¿Cuál es el tipo de esquema para el objeto JSON en swagger 2.0?
Estoy escribiendo un documento API con la ayuda de Swagger 2.0. He generado una API donde la respuesta está en una variedad de libros que funciona bien.
[{ "id": 1, "book_name": "The Complete Reference Java8", "author": "Herbert Schidt", "genre": "Technology" }, { "id": 2, "book_name": "C Programming", "author": "Dennis Ritchie", "genre": "Technology" }]Pavonearse
/fetchBooks: get: description: | Returns an array of book objects. responses: 200: description: Successful response schema: title: ArrayOfBooks type: array items: type: object properties: id: type: integer book_name: type: string author: type: string genre: type: string Bueno, quiero enviar solo los detalles de un libro en una API en JSONObject qué tipo de esquema debo tomar, ya que probé que el objeto no funciona.
{ "id": 1, "book_name": "The Complete Reference Java8", "author": "Herbert Schidt", "genre": "Technology" }Pavonearse
/fetchBook: get: description: | Returns a book object parameters: - name: id in: query description: Books Id's reqrequired: true type: integer format: int responses: 200: description: Successful response schema: type: object <-- What type should I specify for JSONObject here items: type: object properties: id: type: integer book_name: type: string author: type: string genre: type: string Como el objeto no funciona, Swagger no muestra el formato JSON .
Estado actual :
Estado esperado:
2 answers
Answer question0
/fetchBook: get: description: | Returns a book object parameters: - name: id in: query description: Books Id's required: true type: integer format: int responses: '200': description: Successful response schema: type: object properties: id: type: integer book_name: type: string author: type: string genre: type: stringel problema que tuviste fue un error tipográfico en el campo requerido
y el siguiente es la sintaxis correcta para las respuestas de un solo objeto
0
Sugerencia: si desea reutilizar el mismo esquema en varias operaciones, por ejemplo, tener un solo Book y un ArrayOfBooks , puede definir el esquema en la sección de definitions y $ref en otro lugar.
paths: /fetchBooks: get: ... responses: 200: description: Successful response schema: $ref: '#/definitions/ArrayOfBooks' # <-------- /fetchBook: get: ... responses: 200: description: Successful response schema: $ref: '#/definitions/Book' # <-------- definitions: Book: type: object properties: id: type: integer book_name: type: string author: type: string genre: type: string ArrayOfBooks: type: array items: $ref: '#/definitions/Book' # <--------
Además, si se trata de una nueva API en desarrollo y no de una API existente, "buscar" en GET /fetchBooks es redundante (GET = buscar). Considere soltar "buscar" y usar solo GET /books y GET /book?id=... .