Testen Sie die verwendete API Scheinserver Es handelt sich um ein grundlegendes Ferramenta für API-Entwickler. Unsere Hauptvorteile sind:
- Acelera o desenvolvimento: Mock-Server können für ähnliche APIs verwendet werden, oder Sie dürfen die beteiligten Benutzer nur mit ihrem Code testen, nachdem Sie darauf geachtet haben, dass unsere Again-Ends tatsächlich von der API unterstützt werden. Sie können viel Zeit sparen, insbesondere um neue Rekursionen zu entschlüsseln oder Änderungen an vorhandenen APIs vorzunehmen.
- Melhora a qualidade: Mock-Server können verwendet werden, um eine Vielzahl von Szenarien zu testen, da sie ungültig sind, fehlerhafte Fehler und fehlerhafte Inhalte enthalten. Es besteht die Gefahr, dass APIs Fehler schnell erkennen und verbessern.
- Reduz o risco: Mock-Server können isoliert zum Testen von APIs verwendet werden, oder sie können die Gefahr verringern, Teile von Systemen zu entfernen, die in einer API geändert werden müssen.
In diesem Tutorial erfahren Sie, wie Sie schnell API-Mock-Server auf Foundation einer Spezifikation erstellen OpenAPI usando a Vertex-KI e Google Cloud Run.
Durch die Kombination von Vertex AI und Cloud Run können API-Entwickler schnell und einfach Mock-API-Server generieren, die für Checks, Entwicklung und Zusammenarbeit verwendet werden können.
Dies sind die folgenden Schritte:
- Rufen Sie eine OpenAPI-Spezifikation für Ihre API auf.
- Verwenden Sie Generative AI Studio für Vertex AI, um einen Code gemäß der OpenAPI-Spezifikation zu erstellen.
- Installieren Sie einen Scheinserver ohne Cloud Run.
- Testen Sie Ihre API ohne fiktiven Server.
Vamos orientieren sich an jedem dieser Schritte und werden in den darauf folgenden Abschnitten ausführlicher beschrieben.
- Ter ähm Projekt für Google Cloud com faturamento ativado
Neste-Tutorial, usarei Dies ist eine Spezifikation mache OpenAPI .
Vamos komm!
- Bereiten Sie zunächst Ihre OpenAPI-Spezifikationsdatei vor und überprüfen Sie, ob sie für eine On-line-Bereitstellung gültig ist esta.
- Kopieren Sie Ihre OpenAPI-Spezifikation und den Browser Code-Eingabeaufforderung do Generative AI Studio Nr Vertex-KI.
- Verwenden Sie die Eingabeaufforderung (oder personalisieren Sie sie entsprechend Ihren Anforderungen) und lassen Sie sich bestätigen, dass der Textual content durch den reservierten Platz „COLE_SUA_SPEC_AQUI“ durch Ihre OpenAPI-Spezifikation ersetzt wird.
Gere código Python Flask para API de um mock server com base na
seguinte especificação OpenAPI: COLE_SUA_SPEC_AQUI
4. Vertex IA antwortet mit dem Code Python Flask. Abaixo antwortete mir nicht:
from flask import Flask
from flask_restful import Api, Useful resourceapp = Flask(__name__)
api = Api(app)
# Outline as rotas da API
@api.route('/merchandise')
class ProductsResource(Useful resource):
def get(self):
# Retorna uma lista de produtos
return {
'merchandise': [
{
'id': '1',
'name': 'Product 1',
'description': 'This is product 1',
'picture': 'https://example.com/product1.jpg',
'price_usd': {
'currency_code': 'USD',
'units': 100,
'nanos': 0
},
'categories': ['vintage', 'gardening']
},
{
'id': '2',
'identify': 'Product 2',
'description': 'That is product 2',
'image': 'https://instance.com/product2.jpg',
'price_usd': {
'currency_code': 'USD',
'items': 200,
'nanos': 0
},
'classes': ['vintage', 'home']
}
]
}
@api.route('/merchandise/<product_id>')
class ProductResource(Useful resource):
def get(self, product_id):
# Retorna os detalhes de um produto
return {
'id': product_id,
'identify': 'Product 1',
'description': 'That is product 1',
'image': 'https://instance.com/product1.jpg',
'price_usd': {
'currency_code': 'USD',
'items': 100,
'nanos': 0
},
'classes': ['vintage', 'gardening']
}
if __name__ == '__main__':
app.run(debug=True)
Kein : Für die meisten Eingabeaufforderungen müssen Sie einen anderen Code erhalten, den Sie erhalten. Portanto, use-o com cautela. Sie können auch den erforderlichen Code anpassen und weitere Abhängigkeiten hinzufügen.
5. In der Nähe des Tages bereiten wir bitte unseren Code vor, damit er wie ein Cloud Run-Service implantiert werden kann
- Navegue até o Konsole macht GCP
- Überprüfen Sie, ob API Cloud Run in Ihrem Projekt aktiviert ist.
- Abra o Cloud Shell Ich schreie eine Pasta in meinem Hauptverzeichnis
- Siga a Dokumentation hier Um Ihren Code für die Implementierung in Cloud Run vorzubereiten, müssen Sie die folgenden Dateien verwenden: primary.py, require.txt und Dockerfile.
- Nachdem Sie Ihren Code sofort eingegeben haben, können Sie Cloud Run nicht verwenden oder mit gcloud fortfahren
gcloud run deploy
Ich habe einen Namen für Ihren Cloud Run-Dienst (Mock-Server) und eine GCP-Area (z. B. us-central1) angefordert, auf dem Ihr Dienst installiert wurde. Wir empfehlen Ihnen, den Zugriff auf authentische Cloud Run-Dienste zuzulassen.
Warten Sie alle Augenblicke, bis die Implantation abgeschlossen ist. Im Erfolgsfall geben Sie sofort eine URL für den Dienst ein.
In diesem Beispiel schreiben wir einen Apigee-API-Proxy auf Foundation der zuvor erwähnten OpenAPI-Spezifikation. Anschließend verwenden wir den Mock Server, den wir zuvor erstellt haben, um unseren API-Proxy von Apigee zu testen.
- Navigieren Sie zur Konsole Apigeewenn es noch nicht konfiguriert ist, ist es so Hier
- Rufen Sie einen API-Proxy auf, der Ihre OpenAPI-Spezifikation verwendet, und zwar in den folgenden Schritten hier beschrieben. Verwenden Sie eine URL für den Cloud Run-Dienst wie „Proxy-Zielendpunkt“.
- Wenn Sie Ihren Cloud Run-Dienst so konfigurieren, dass er authentische Aufrufe ermöglicht, müssen Sie einen Dienstinhalt hinzufügen und die Funktion „Cloud Run Invoker“ aktivieren. Bevor Sie dies tun, müssen Sie Ihren Apigee-Proxy konfigurieren, um ihn als Dienstinhalt verwenden zu können, um Ihren Mock-Server aufzurufen. Detaillierte Anweisungen finden Sie hier Hier sind die Erklärungen
- Sie können einen API-Shopper wie Postman verwenden, um die API für Ihren API-Proxy zu nutzen und Ihre Endpunkte zu testen. Dazu gehören zwei Beispiele:
Beispiel 1 : Erhalten Sie alle Produkte
Beispiel 2 : Erhalten Sie ein bestimmtes Produkt (zum Beispiel, id=1)
Dieser Artikel basiert auf einer neuen Type der Nutzung von Vertex AI, um den Code automatisch zu verwenden und GenAI zu verwenden, ohne Cloud Run bereitzustellen
Ihr Vorschlag lautet, dass er hier am besten ankommt! 📢
Basierend auf dem Porto: https://medium.com/@hbougdal_90846/how-to-quickly-create-api-mock-servers-using-bard-and-cloud-run-9240ccca0543
