API'leri hesaplar, bölgeler veya platformlar arasında geçiş yapmak amacıyla bir API grubundan OAS 2.0 veya OAS 3.0 formatında dışa aktarabilirsiniz.
Genel bakış
API Gateway'den API'leri OAS formatında dışa aktarabilirsiniz. Bu işlem, API içe aktarma özelliğiyle birlikte kullanıldığında aşağıdaki senaryoları destekler. API içe aktarma özelliği hakkında daha fazla bilgi için bkz. OAS uyumlu API'leri içe aktarma.
API'leri hesaplar, bölgeler veya platformlar arasında geçirin: API Gateway'den veya başka bir platformdan OAS uyumlu API'leri dışa aktarın ve ardından bunları farklı bir Alibaba Cloud hesabına, bölgeye veya platforma aktarın.
API'leri yayınlayın ve genişletin: OAS uyumlu API tanımlarını API Gateway'deki API kaynaklarına dönüştürerek API'leri hızla oluşturun ve yapılandırın, ardından ihtiyaçlarınıza göre davranışlarını özelleştirin. API Gateway; erişim izinlerini yönetmenize, trafiği kısıtlamanıza ve istekleri güvenli bir şekilde yönlendirmenize yardımcı olur.
Entegrasyon ve iş birliği yapın: Dışa aktarılan API'leri OAS standardına dayalı diğer geliştirme araçlarıyla veya platformlarla entegre edin. API tanımlarının paylaşılması, ekipler arasındaki iletişim yükünü ve geliştirme çabasını azaltır.
OAS uyumlu API'leri dışa aktarma
Tüm bir API grubunu veya belirli API'leri dışa aktarabilirsiniz.
Yordam
-
Bir API grubunu dışa aktarma
API Gateway konsoluna giriş yapın.
Sol gezinme bölmesinde Manage APIs > API Groups seçeneğini belirleyin.
API Groups sayfasında dışa aktarmak istediğiniz API grubunu bulun.
simgesine tıklayın ve ardından Actions sütununda Export API Definitions seçeneğini belirleyin.Export API Definitions iletişim kutusunda Data Format, Stage ve Export Extended Definitions parametrelerini belirtin. Ardından Confirm öğesine tıklayın.
-
Belirli API'leri dışa aktarma
API Gateway konsoluna giriş yapın.
Sol gezinme bölmesinde Manage APIs > APIs seçeneğini belirleyin.
APIs sayfasında dışa aktarmak istediğiniz API'leri seçin ve listenin altındaki More > Export API Definitions seçeneğini belirleyin.
Export API Definitions iletişim kutusunda Data Format, Stage ve Export Extended Definitions parametrelerini belirtin. Ardından Confirm öğesine tıklayın.
Genişletilmiş API tanımları
Export Extended Definitions parametresi için Yes değerini seçerseniz dışa aktarılan dosyalara aşağıdaki API Gateway'e özel alanlar eklenir.
|
Genişletilmiş alan |
OAS 2.0'daki konumu |
OAS 3.0'daki konumu |
Açıklama |
Tür |
Geçerli değerler |
|
x-aliyun-apigateway-any-method |
Paths Object |
Paths Object |
ANY yönteminin tam tanımı. |
Object |
- |
|
x-aliyun-apigateway-backend |
Operation Object |
Operation Object |
Arka uç hizmeti. |
Object |
- |
|
x-aliyun-apigateway-api-market-enable |
Operation Object |
Operation Object |
API'nin Alibaba Cloud Marketplace'te yayınlanmasına izin verilip verilmeyeceğini belirtir. |
Boolean |
|
|
x-aliyun-apigateway-api-force-nonce-check |
Operation Object |
Operation Object |
Tekrar korumanın etkinleştirilip etkinleştirilmeyeceğini belirtir. |
Boolean |
|
|
x-aliyun-apigateway-parameter-handling |
Operation Object |
Operation Object |
İstek tanımındaki istek modu. |
String |
|
|
x-aliyun-apigateway-auth-type |
Operation Object |
Operation Object |
Güvenlik kimlik doğrulama türü. |
String |
|
|
x-aliyun-apigateway-app-code-type |
Operation Object |
Operation Object |
AppCode kimlik doğrulama türü. |
String |
|
|
x-aliyun-apigateway-constant-parameters |
Operation Object |
Operation Object |
Sabit parametre tanımları. |
Object |
- |
|
x-aliyun-apigateway-system-parameters |
Operation Object |
Operation Object |
Sistem parametresi tanımları. |
Object |
- |
|
x-aliyun-apigateway-api-enable-internet |
Operation Object |
Operation Object |
İnternet üzerinden erişime izin verilip verilmeyeceğini belirtir. |
Boolean |
|
|
x-aliyun-apigateway-success-demo |
Operation Object |
Operation Object |
Başarılı bir çağrı için örnek dönüş değeri. |
String |
- |
|
x-aliyun-apigateway-failed-demo |
Operation Object |
Operation Object |
Başarısız bir çağrı için örnek dönüş değeri. |
String |
- |
|
x-aliyun-apigateway-api-name |
Operation Object |
Operation Object |
API adı. |
String |
- |
|
x-aliyun-apigateway-request-scheme |
N/A |
Operation Object |
HTTP gibi API tarafından desteklenen protokoller. |
String |
- |
|
x-aliyun-apigateway-backend-location |
Parameter Object |
Parameter Object |
Arka uç hizmetindeki eşlenen parametre konumları. |
String |
|
|
x-aliyun-apigateway-backend-name |
Parameter Object |
Parameter Object |
Arka uç hizmetindeki eşlenen parametre adları. |
String |
- |
|
x-aliyun-apigateway-parameter-demo |
Parameter Object |
Parameter Object |
Örnek parametre değerleri. |
String |
- |
|
x-aliyun-apigateway-response-messages |
Responses Object |
Responses Object |
Hata tanımlarındaki hata mesajları. |
String |
- |
Açıklama
Gruba göre dışa aktarma yaparsanız grubun temel yolu da dışa aktarılır.
Bir seferde en fazla 300 API dışa aktarabilirsiniz. Dışa aktarılacak grupta 300'den fazla API varsa ilk 300 API dışa aktarılır.
Bir API grubunun model tanımı ayrıştırılamazsa model tanımı dışa aktarılmaz.
Belirli API'leri dışa aktarırsanız seçilen tüm API'ler aynı dosyaya aktarılır.
API'lerin yolu ve yöntemi aynıysa bu API'lerden yalnızca biri dışa aktarılır.
Export Extended Definitions parametresi için No değerini seçerseniz dışa aktarılan dosyadaki OperationId değeri, API tanımının istek yolu ve istek yönteminden oluşan birleşik bir dizedir (örneğin export1ByGET).
Export Extended Definitions parametresi için Yes değerini seçerseniz API'ye ilişkin ek bilgiler (bağlı eklenti, yetkilendirilmiş uygulama, API grubunun bağlı alan adı ve farklı ortamlardaki arka uç hizmeti tanımları gibi) dışa aktarılmaz.
Örnek
Aşağıdaki örnekte genişletilmiş API tanımlarıyla dışa aktarılan bir API grubu gösterilmektedir.
swagger: '2.0'
info:
description: Export from api group xxx
version: 1.0.0
title: Api Gateway API
basePath: /export
paths:
/export1/{pathParam}:
get:
summary: test export job 1.
operationId: export1pathParamByGET
schemes:
- http
- https
parameters:
- name: pathParam
in: path
description: the path parameter.
required: true
type: string
maxLength: 10
x-aliyun-apigateway-parameter-demo: pathValue
x-aliyun-apigateway-backend-name: pathParam
x-aliyun-apigateway-backend-location: path
- name: headParam
in: header
description: the header parameters.
required: false
type: string
x-aliyun-apigateway-parameter-demo: headerValue
x-aliyun-apigateway-backend-name: headParam
x-aliyun-apigateway-backend-location: query
- name: queryParam
in: query
description: the query parameters.
required: false
type: string
x-aliyun-apigateway-parameter-demo: queryValue
x-aliyun-apigateway-backend-name: queryParam
x-aliyun-apigateway-backend-location: header
responses:
'200':
description: success.
x-aliyun-apigateway-response-messages: success
'400':
description: client error.
x-aliyun-apigateway-response-messages: clent error
'500':
description: server error.
x-aliyun-apigateway-response-messages: server error
x-aliyun-apigateway-system-parameters:
- backendName: testClientIp
systemName: CaClientIp
location: header
x-aliyun-apigateway-constant-parameters:
- backendName: constantparam
location: header
value: constantValue
descriptoin: the constant parameters.
x-aliyun-apigateway-api-name: export_1
x-aliyun-apigateway-api-market-enable: false
x-aliyun-apigateway-api-force-nonce-check: true
x-aliyun-apigateway-parameter-handling: MAPPING
x-aliyun-apigateway-auth-type: APP
x-aliyun-apigateway-api-enable-internet: true
x-aliyun-apigateway-failed-demo: '{"result":"fail"}'
x-aliyun-apigateway-success-demo: '{"result":"success"}'
x-aliyun-apigateway-app-code-type: DEFAULT
x-aliyun-apigateway-backend:
body: good job
statusCode: 200
header:
- name: test
value: header1
type: MOCK
/export2/*:
x-aliyun-apigateway-any-method:
operationId: export_2
description: test export job 1.
x-aliyun-apigateway-api-market-enable: false
x-aliyun-apigateway-api-force-nonce-check: false
x-aliyun-apigateway-api-enable-internet: true
x-aliyun-apigateway-parameter-handling: PASSTHROUGH
x-aliyun-apigateway-auth-type: ANONYMOUS
x-aliyun-apigateway-success-demo: '{"result":"success"}'
x-aliyun-apigateway-failed-demo: '{"result":"fail"}'
schemes:
- http
- https
x-aliyun-apigateway-backend:
body: good job
statusCode: 200
header:
- name: test
value: header1
type: MOCK
x-aliyun-apigateway-constant-parameters:
- backendName: constantparam
location: header
value: constantValue
descriptoin: the constant parameters.
x-aliyun-apigateway-system-parameters:
- backendName: testClientIp
systemName: CaClientIp
location: header
responses:
'200':
description: success.
briefMessage: success
schema:
$ref: testModel
'400':
description: client error.
briefMessage: clent error
schema:
$ref: testModel
'500':
description: server error.
briefMessage: server error
definitions:
testModel:
type: object
required:
- name
properties:
dogProject:
type: object
properties:
name:
type: string
maxLength: 10
id:
type: integer
format: int64
name:
type: string
pattern: ^\d{3}-\d{2}-\d{4}$
id:
type: integer
format: int64
status:
type: string