OpenAPI / Swagger

Paylox API'nin OpenAPI (Swagger) spesifikasyonu ile otomatik istemci oluşturma ve interaktif dokümantasyon.

OpenAPI Spesifikasyonu

Paylox API, OpenAPI 3.0 formatında tanımlanmıştır. Bu spesifikasyon dosyası ile:

• Swagger UI üzerinden interaktif API testi yapabilirsiniz
• Otomatik istemci kütüphaneleri oluşturabilirsiniz
• API değişikliklerini takip edebilirsiniz

Swagger UI

Sandbox ortamının Swagger UI arayüzü:

https://testapi.jetcheckout.com/docs

Bu arayüzden:

• Tüm endpoint'leri görebilirsiniz
• İstek ve yanıt şemalarını inceleyebilirsiniz
• Doğrudan API çağrısı yapabilirsiniz

Otomatik İstemci Oluşturma

OpenAPI spec dosyasını kullanarak farklı dillerde istemci kütüphaneleri oluşturabilirsiniz:

openapi-generator ile

npm install @openapitools/openapi-generator-cli -g

openapi-generator-cli generate \
  -i https://testapi.jetcheckout.com/openapi.json \
  -g python \
  -o ./paylox-python-client

openapi-generator-cli generate \
  -i https://testapi.jetcheckout.com/openapi.json \
  -g typescript-fetch \
  -o ./paylox-ts-client

openapi-generator-cli generate \
  -i https://testapi.jetcheckout.com/openapi.json \
  -g csharp \
  -o ./paylox-dotnet-client

Desteklenen Diller

openapi-generator ile oluşturulabilecek istemciler:

Dil	Generator Adı
Python	python
TypeScript	typescript-fetch
Java	java
C#	csharp
Go	go
Ruby	ruby
PHP	php
Kotlin	kotlin
Swift	swift5
Dart	dart

Postman'e Import

OpenAPI spec dosyasını Postman'e import ederek hazır bir collection oluşturabilirsiniz:

1. Postman'i açın
2. Import butonuna tıklayın
3. Link sekmesine geçin
4. URL'yi yapıştırın: https://testapi.jetcheckout.com/openapi.json
5. Import butonuna tıklayın

Tüm endpoint'ler otomatik olarak collection'a eklenir.