API-Bereitstellung

Erstellen, Testen und Freigeben von APIs unter Verwendung moderner Bereitstellungspipelines und bewährter technischer Verfahren.

Ergebnisse

• APIs, die mit getesteten Frameworks und Mustern implementiert werden

Zugehörige Metro-Linien

• API-Entwurfslinie
• Bereitstellungslinie

Warum das wichtig ist

Selbst die besten API-Designs scheitern, wenn die Bereitstellung uneinheitlich ist. Diese Station stellt sicher, dass Ihre APIs qualitativ hochwertig erstellt, gründlich getestet und zuverlässig bereitgestellt werden - für schnellere Iterationen und mehr Vertrauen.

Eintrittskriterien

• Die API-Architektur verwendet Muster, die die Wiederverwendbarkeit und Integration fördern, und wird mit den Stakeholdern validiert.
• Das Ziel der API ist es, Backend-Datenmodelle und Diskrepanzen zu verbergen.
• Das Design und die Endpunkte der API stehen in klarem Zusammenhang mit ihrem geschäftlichen Nutzen und ihren Funktionen.
• Die API weist ein einheitliches Design mit unseren anderen API-Produkten auf.

Austrittskriterien

• Die API-Architektur verwendet Muster, die die Wiederverwendbarkeit und Integration fördern, und wird mit den Stakeholdern validiert.
• Das Design und die Endpunkte der API stehen in klarem Zusammenhang mit ihrem geschäftlichen Nutzen und ihren Funktionen.
• Die API und ihre Endpunkte verfügen über Beschreibungen, die ihren geschäftlichen Nutzen und ihre Funktionen erläutern.
• Die API weist ein einheitliches Design mit unseren anderen API-Produkten auf.
• Der API-Vertrag wurde getestet und erfüllt die funktionalen und nicht-funktionalen Anforderungen.

Wie es funktioniert

1. Verwendung etablierter Frameworks und Bibliotheken zur Implementierung von APIs, um sicherzustellen, dass sie wiederverwendbar und wartbar sind.
   Bewährte Praktiken der API-Entwicklung Richtlinien zur Förderung konsistenter, wartbarer API-Codebasen unter Verwendung von Standardbibliotheken, wiederverwendbaren Mustern und abgestimmten Entwicklungsabläufen.
2. Wenden Sie Contract-First- oder Design-First-Ansätze an, um sicherzustellen, dass API-Verträge vor der Implementierung validiert werden.
   Vertrag Erstes Design Ein Leitfaden, der für API-first-Ansätze plädiert, bei denen formale Verträge (z. B. OpenAPI) verwendet werden, um die Beteiligten vor der Entwicklung aufeinander abzustimmen.
3. Testen Sie APIs auf Funktionalität, Sicherheit und Leistung mit automatisierten Testwerkzeugen.
   Bewährte Praktiken für API-Tests Richtlinien für die Implementierung automatisierter Funktions-, Leistungs- und Sicherheitstests während des gesamten API-Lebenszyklus.
4. Verwenden Sie CI/CD-Pipelines, um Build-, Test- und Bereitstellungsprozesse zu automatisieren und so konsistente Qualität und Nachvollziehbarkeit zu gewährleisten.
   APIOps CI/CD für APIs Bereitstellungsleitfaden, der die Aufgaben des API-Lebenszyklus - Entwurf, Tests, Governance - in die Pipelines für die kontinuierliche Integration und Bereitstellung integriert.
5. Stellen Sie sicher, dass APIs die Sicherheits- und Compliance-Anforderungen durch automatische Prüfungen und Audits erfüllen.
   Bewährte Praktiken für die API-Sicherheit Eine Reihe praktikabler Kontrollen zur Sicherung von APIs, einschließlich Authentifizierung, Autorisierung, Verschlüsselung, Ratenbegrenzung und Konformitätsprüfungen auf Pipeline-Ebene.
6. Verwenden Sie die API-Audit-Checkliste, um sicherzustellen, dass die API die funktionalen und nicht-funktionalen Anforderungen erfüllt, einschließlich Sicherheit, Leistung und Compliance.
   API Audit Checkliste Eine umfassende Checkliste zur Überprüfung der API-Bereitschaft vor der Veröffentlichung, die Design, Dokumentation, Sicherheit und die Einhaltung von Richtlinien abdeckt.

Bei Ihrer Arbeit anwenden

Bereitstellung von Kodierungsrahmen, Bibliotheken und Standards für die API-Implementierung. Implementierung von CI/CD-Pipelines, Qualitätssicherungs-Frameworks und Tools zur Automatisierung der Bereitstellung.