Geben Sie ein array von strings als parameter body in swagger-API

Ich würde gerne post ein array von strings, wie

[
  "id1",
  "id2"
]

einem Swagger-basierte API. In meinem swagger-Datei habe ich diese Zeilen:

paths:
  /some_url:
    post:
      parameters:
        - name: ids
          in: body
          required: true

Was ist der richtige Weg, um geben Sie den Typ der ids als ein array von strings?

Update:

Laut Spezifikation sollten die folgenden arbeiten in meiner option:

  parameters:
    - in: body
      description: xxx
      required: true
      schema:
        type: array
        items:
          type: string

https://github.com/Yelp/swagger_spec_validator nicht akzeptieren, und es gibt eine lange Liste von gewundenen Fehler, die Aussehen wie der code erwartet, dass einige $ref.

InformationsquelleAutor Achim | 2016-09-01

24

Deiner Beschreibung ein array von string ist korrekt, aber die parameter-definition findet der name Eigenschaft, um gültig zu sein.

Hier ein voll funktionsfähiges Beispiel:
```
swagger: "2.0"

info:
  title: A dummy title
  version: 1.0.0

paths:
  /path:
    post:
      parameters:
        - in: body
          description: xxx
          required: true
          name: a name
          schema:
            type: array
            items:
              type: string
      responses:
        default:
          description: OK
```
Versuchen, online-editor, um überprüfen Sie Ihre Open API (fka. Swagger) Spezifikationen: http://editor.swagger.io/
- Es sollte darauf hingewiesen werden mit den neuesten Fors codegen (2-2-3) mit diesem Konstrukt wird eine null-Zeiger-Ausnahme. Verwenden Sie eine Referenz auf einen Typ statt.
InformationsquelleAutor Arnaud Lauret
6

Habe ich einen swagger Frage, wie die Hilfe durch Arnaud, obwohl gültig ist yaml, wird Ihnen NPE Ausnahmen, wenn Sie versuchen zu generieren. Sie brauchen ein Objekt, wie die folgenden:
```
  myDataItem:
    type: object
    description: A list of values
    required:
      - values
    properties:
      values:
        type: array
        items:
            type: string
```
Und dann finden Sie es (in Ihrem Element post etc):
```
  schema:
    $ref: "#/definitions/myDataItem"
```
Referenz für den github issue:

https://github.com/swagger-api/swagger-codegen/issues/6745

Hinweis, der Fehler wurde behoben in der version 2.3.0 und höher, idealerweise sollten Sie ein upgrade auf diese version.

InformationsquelleAutor PeterS
2

Für Array-Objekt als Inhalt es ist, die definition für das Objekt kann auch ausgedrückt werden Definitionen & $ref.
Beispiel:
```
schema:
    type: array
    items:
        $ref: '#/definitions/ObjectSchemaDefinition'
definitions:
    ObjectSchemaDefinition:
        type: string
```
InformationsquelleAutor Abhijeet
0

Die Antwort mit den meisten Stimmen hat mich in die richtige Richtung. Ich brauchte nur ein Beispiel für ein array von Objekten, wobei jede von Ihnen hatte eine Eigenschaft, die ein array von strings mit mehr als einem Wert in der Zeichenfolgen-array. Dank der Dokumentation Ich habe es funktioniert so:
```
MyObject:
  type: object
  properties:
    body:
      type: array
      items:
        type: object
        properties:
          type: 
            type: string
          values: 
            type: array
            items:
              type: string
      example: 
        - type: "firstElement"
          values: ["Active", "Inactive"]
        - type: "SecondElement"
          values: ["Active", "Inactive"]
```
Eine Sache im Auge zu behalten ist, dass die Einbuchtung ist von entscheidender Bedeutung zu stolzieren. Wenn Sie nicht Einrücken, die Dinge gut, swagger geben Sie seltsame Fehlermeldungen.

InformationsquelleAutor Lucio Mollinedo

Schreibe einen Kommentar

Du musst angemeldet sein, um einen Kommentar abzugeben.