{"id":2114,"date":"2017-10-16T09:23:16","date_gmt":"2017-10-16T07:23:16","guid":{"rendered":"https:\/\/bob-team.de\/wordpress\/?p=2114"},"modified":"2026-06-13T18:01:50","modified_gmt":"2026-06-13T16:01:50","slug":"api-mit-swagger-dokumentieren","status":"publish","type":"post","link":"https:\/\/bob-team.de\/wordpress\/2017\/10\/16\/api-mit-swagger-dokumentieren\/","title":{"rendered":"API mit Swagger dokumentieren"},"content":{"rendered":"<p><a href=\"https:\/\/editor.swagger.io\/\">Swagger Editor<\/a><\/p>\n<p>Beispiel &#8222;openapi.yaml&#8220;:<\/p>\n<pre lang=\"yaml\">\r\nopenapi: 3.0.4\r\ninfo:\r\n  title: Demo API\r\n  version: 1.0.0\r\n\r\nservers:\r\n  - url: https:\/\/c-intact.d-velop.cloud\/scripting\/script\/09399c54-15a4-4ea5-af4c-6ed1208bd07c\/run\r\n  - url: https:\/\/webhook.site\/2d8ba29a-87ca-49ff-bc97-b265f3bc089f\r\n\r\ntags:\r\n  - name: aeink\r\n    description: Einkaufsakte\r\n  - name: averk\r\n    description: Verkaufsakte\r\n\r\npaths:\r\n  \/aeinkByAnfnr:\r\n    post:\r\n      tags:\r\n        - aeink\r\n      summary: Erstellt eine Einkaufsakte zur EK-Anfragenummer.\r\n      description: sucht \"ekanfnr\", ohne Treffer wird Akte mit allen Eigenschaften angelegt\r\n      requestBody:\r\n        required: true\r\n        content:\r\n          application\/json:\r\n            schema:\r\n              type: object\r\n              required:\r\n                - ekanfnr\r\n                - anfbez\r\n              properties:\r\n                liefnr:\r\n                  type: string\r\n                  example: \"1001\"\r\n                liefname:\r\n                  type: string\r\n                  example: \"Mustermann AG\"\r\n                ekabt:\r\n                  type: string\r\n                  example: \"Einkauf\"\r\n                ekanfnr:\r\n                  type: string\r\n                  example: \"A260001\"\r\n                anfbez:\r\n                  type: string\r\n                  example: \"Demo-Anfrage\"\r\n      responses:\r\n        \"200\":\r\n          description: Erfolgreich\r\n        \"400\":\r\n          description: Bad Request\r\n      security:\r\n        - AnmeldungDemoApi: []\r\n    put:\r\n      tags:\r\n        - aeink\r\n      summary: Aktualisiert eine Einkaufsakte \u00fcber die EK-Anfragenummer.\r\n      description: gesucht wird \"ekanfnr\", bei Treffer werden alle optionalen Felder \u00fcberschrieben\r\n      requestBody:\r\n        required: true\r\n        content:\r\n          application\/json:\r\n            schema:\r\n              type: object\r\n              required:\r\n                - ekanfnr\r\n              properties:\r\n                liefnr:\r\n                  type: string\r\n                  example: \"1001\"\r\n                liefname:\r\n                  type: string\r\n                  example: \"Mustermann AG\"\r\n                ekabt:\r\n                  type: string\r\n                  example: \"Einkauf\"\r\n                ekanfnr:\r\n                  type: string\r\n                  example: \"A260001\"\r\n                anfbez:\r\n                  type: string\r\n                  example: \"Demo-Anfrage\"\r\n      responses:\r\n        \"200\":\r\n          description: Erfolgreich\r\n        \"400\":\r\n          description: Bad Request\r\n      security:\r\n        - AnmeldungDemoApi: []\r\n  \/aeinkByBestnr:\r\n    post:\r\n      tags:\r\n        - aeink\r\n      summary: Erstellt eine Einkaufsakte f\u00fcr die eigene Bestellnummer.\r\n      description: Bestellnummer aus LN, nicht Bestellnummer vom Lieferanten, optionale Felder werden ggf. leer verwendet; sucht \"bestnr\", ohne Treffer wird Akte mit allen Eiegenschaften angelegt\r\n      requestBody:\r\n        required: true\r\n        content:\r\n          application\/json:\r\n            schema:\r\n              type: object\r\n              required:\r\n                - bestnr\r\n              properties:\r\n                liefnr:\r\n                  type: string\r\n                  example: \"1001\"\r\n                liefname:\r\n                  type: string\r\n                  example: \"Mustermann AG\"\r\n                ekabt:\r\n                  type: string\r\n                  example: \"Einkauf\"\r\n                bestnr:\r\n                  type: string\r\n                  example: \"B260001\"\r\n      responses:\r\n        \"200\":\r\n          description: Erfolgreich\r\n        \"400\":\r\n          description: Bad Request\r\n      security:\r\n        - AnmeldungDemoApi: []\r\n    put:\r\n      tags:\r\n        - aeink\r\n      summary: Aktualisiert eine Einkaufsakte \u00fcber die eigene Bestellnummer.\r\n      description: gesucht wird \"bestnr\", bei Treffer werden alle optionalen Felder \u00fcberschrieben\r\n      requestBody:\r\n        required: true\r\n        content:\r\n          application\/json:\r\n            schema:\r\n              type: object\r\n              required:\r\n                - bestnr\r\n              properties:\r\n                liefnr:\r\n                  type: string\r\n                  example: \"1001\"\r\n                liefname:\r\n                  type: string\r\n                  example: \"Mustermann AG\"\r\n                ekabt:\r\n                  type: string\r\n                  example: \"Einkauf\"\r\n                bestnr:\r\n                  type: string\r\n                  example: \"B260001\"\r\n      responses:\r\n        \"200\":\r\n          description: Erfolgreich\r\n        \"400\":\r\n          description: Bad Request\r\n      security:\r\n        - AnmeldungDemoApi: []\r\n\r\ncomponents:\r\n  securitySchemes:\r\n    AnmeldungDemoApi:\r\n      type: apiKey\r\n      in: header\r\n      name: x-demo-key\r\n<\/pre>\n","protected":false},"excerpt":{"rendered":"<p>Swagger Editor Beispiel &#8222;openapi.yaml&#8220;: openapi: 3.0.4 info: title: Demo API version: 1.0.0 servers: &#8211; url: https:\/\/c-intact.d-velop.cloud\/scripting\/script\/09399c54-15a4-4ea5-af4c-6ed1208bd07c\/run &#8211; url: https:\/\/webhook.site\/2d8ba29a-87ca-49ff-bc97-b265f3bc089f tags: &#8211; name: aeink description: Einkaufsakte &#8211; name: averk description: Verkaufsakte paths: \/aeinkByAnfnr: post: tags: &#8211; aeink summary: Erstellt eine Einkaufsakte zur EK-Anfragenummer. description: sucht &#8222;ekanfnr&#8220;, ohne Treffer wird Akte mit allen Eigenschaften angelegt requestBody: required: [&hellip;]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[1],"tags":[158],"class_list":["post-2114","post","type-post","status-publish","format-standard","hentry","category-uncategorized","tag-swagger","entry"],"_links":{"self":[{"href":"https:\/\/bob-team.de\/wordpress\/wp-json\/wp\/v2\/posts\/2114","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/bob-team.de\/wordpress\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/bob-team.de\/wordpress\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/bob-team.de\/wordpress\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/bob-team.de\/wordpress\/wp-json\/wp\/v2\/comments?post=2114"}],"version-history":[{"count":5,"href":"https:\/\/bob-team.de\/wordpress\/wp-json\/wp\/v2\/posts\/2114\/revisions"}],"predecessor-version":[{"id":4370,"href":"https:\/\/bob-team.de\/wordpress\/wp-json\/wp\/v2\/posts\/2114\/revisions\/4370"}],"wp:attachment":[{"href":"https:\/\/bob-team.de\/wordpress\/wp-json\/wp\/v2\/media?parent=2114"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/bob-team.de\/wordpress\/wp-json\/wp\/v2\/categories?post=2114"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/bob-team.de\/wordpress\/wp-json\/wp\/v2\/tags?post=2114"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}