API-Design

Wir unterstützen Sie bei der Konzeption von RESTful-API-Routen für Ihre Webanwendung.

Bei der Entwicklung Ihrer API-Routen befolgen wir dieselben Schritte, die auch in unserem Softwareentwicklungszyklus festgelegt sind: Planung, Design, Implementierung, Test und Bereitstellung.

Planung

Was wir in der Planungsphase von Ihnen erwarten

1. Bitte planen Sie für dieses Meeting maximal zwei Stunden Ihrer Arbeitszeit ein.
2. Das Anforderungsdokument wird auf der Grundlage der von Ihnen bereitgestellten Informationen erstellt. Dabei wird von Ihnen erwartet, dass Sie:
   • wissen, wer Ihre Nutzer sind (z. B. Administratoren, Gäste usw.);
   • wissen, welche Aktionen Ihre Nutzer mit Ihrer API durchführen können:
     • Informationen in Ihrer Webanwendung erstellen, lesen, aktualisieren oder löschen;
   • wissen, wie Ihre Nutzer auf Ihre API zugreifen können:
     • durch das Senden von POST-, GET-, PUT- und DELETE-Anfragen an Ihre Webanwendung.

Was Sie in der Planungsphase von uns erwarten können

1. Ein finales Dokument mit den API-Anforderungen, erstellt auf der Grundlage der von Ihnen bereitgestellten Informationen.
2. Dieses Dokument muss freigegeben werden, bevor mit der Designphase begonnen wird.

Design und Implementierung

1. Auf der Grundlage Ihrer Anforderungen wird ein OpenAPI-Dokument erstellt.
2. Nachfolgend finden Sie ein Beispiel für eine .yaml-Datei:

openapi: '3.1.0'
info:
  version: '1.0.0'
  title: 'Sample API'
  description: Sample API for the recipes and restaurants

servers:
  - url: https://stuntbusiness.cdapi

paths:
      
  /recipe:
    get:
      security: 
          - bearerAuth: [] 
      summary: Get the list of recipes
      operationId: getAllRecipes
      responses:
        200:
          description: The array of recipes 
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Recipes"
        500:
          description: Unexpected error 
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"

    # Other paths here.

• Wir übernehmen auch die Implementierung der oben genannten YAML-Datei in Ihr Backend. Hierfür werden die regulären Sätze für die Backend-Entwicklung berechnet.

Tests und Bereitstellung

• Wir führen die API-Tests durch und stellen Ihnen eine Liste der erstellten Tests zur Verfügung.
• Die fertige API wird Ihnen in einem Git-Repository bereitgestellt.

Preise

Leistungen	Stundensatz
HTTP-API-Design	125.000 FC/Std.
Backend-Entwicklung	125.000 FC/Std.

Bereit zur Beauftragung?

• Kontaktieren Sie uns