Ringkasan desain API

Anda sedang melihat dokumentasi Apigee Edge.
Buka Dokumentasi Apigee X. info

Pada fase Desain, Anda menentukan persyaratan untuk API. Sebagai desainer API, Anda merencanakan layanan yang ingin ditampilkan kepada konsumen, dan mendesain API untuk mengakses layanan tersebut. Anda membuat salah satu dokumen berikut untuk memenuhi persyaratan API:

  • Dokumen OpenAPI
  • Skema GraphQL

Bagian berikut memberikan informasi lebih lanjut tentang dokumen OpenAPI dan GraphQL serta perannya dalam siklus proses API Anda. Untuk perbandingan antara dua opsi desain API, lihat perbandingan REST dan GraphQL dalam postingan blog ini.

Apa itu Spesifikasi OpenAPI?


"OpenAPI Initiative (OAI) berfokus pada pembuatan, pengembangan, dan promosi Format Deskripsi API yang netral bagi vendor berdasarkan Spesifikasi Swagger." Untuk informasi selengkapnya tentang Inisiatif OpenAPI, lihat https://openapis.org.

Dokumen OpenAPI menggunakan format standar untuk menjelaskan RESTful API. Ditulis dalam format JSON atau YAML, dokumen OpenAPI dapat dibaca oleh mesin, tetapi juga mudah dibaca dan dipahami orang. Spesifikasi OpenAPI memungkinkan deskripsi formal elemen API seperti jalur dasar, jalur dan kata kerja, header, parameter kueri, jenis konten, model respons, dan banyak lagi. Selain itu, dokumen OpenAPI biasa digunakan untuk menghasilkan dokumentasi API.

Berikut adalah fragmen dari dokumen OpenAPI yang menjelaskan contoh hello world sederhana dari Apigee. Untuk informasi lebih lanjut, lihat Spesifikasi OpenAPI di GitHub.

openapi: 3.0.0
info:
  description: OpenAPI Specification for the Apigee mock target service endpoint.
  version: 1.0.0
  title: Mock Target API
paths:
  /:
    get:
      summary: View personalized greeting
      operationId: View a personalized greeting
      description: View a personalized greeting for the specified or guest user.
      parameters:
        - name: user
          in: query
          description: Your user name.
          required: false
          schema:
            type: string
      responses:
        "200":
          description: Success
  /help:
    get:
      summary: Get help
      operationId: Get help
      description: View help information about available resources in HTML format.
      responses:
        "200":
          description: Success
...

Tersedia banyak sumber informasi yang sangat baik tentang Spesifikasi OpenAPI. Sebaiknya mulai dengan situs OpenAPI Initiative, tempat Anda akan menemukan ringkasan, blog, dan link ke Spesifikasi OpenAPI. Lihat Spesifikasi untuk deskripsi mendetail tentang elemen skema dan jenis data.

Ada sejumlah dokumen OpenAPI contoh JSON dan YAML yang dapat Anda download dari Repositori Spesifikasi OpenAPI.

Apa itu skema GraphQL?

Skema GraphQL menjelaskan data yang tersedia di API Anda untuk dikueri oleh klien.

Manfaat menggunakan GraphQL meliputi:

  • Endpoint tunggal memberikan akses ke semua kolom untuk operasi tertentu
  • Bahasa query yang canggih, yang disebut {i>Schema Definition Language<i}, memungkinkan Anda untuk mengakses data yang Anda butuhkan dengan tepat, mencegah pengambilan data secara berlebihan atau kurang.
  • Pemrosesan kueri terjadi secara paralel

Untuk mengetahui informasi selengkapnya tentang GraphQL, lihat graphql.org.

Berikut ini contoh skema GraphQL yang menentukan titik entri data (jenis Kueri), operasi tulis yang tersedia (jenis Mutasi), dan jenis data.

type Query {
  Greeting: String
  students: [Student]
}
type Mutation {
  createStudent(firstName: String!, lastName: String!): Student!
}
type Subscription {
  newStudent: Student!
}
type Student {
  Id: ID!
  firstName: String!
  lastName: String!
  password: String!
  collegeId: String!
}

Anda dapat membuat kueri skema GraphQL untuk menampilkan data yang tepat yang diperlukan sebagai payload JSON.

Kueri dan hasil GraphQL

Apa yang terjadi jika saya mengubah dokumen?

Setiap dokumen OpenAPI atau GraphQL berfungsi sebagai sumber kebenaran di sepanjang siklus proses API. Dokumen yang sama digunakan di setiap fase dalam siklus proses API, mulai dari pengembangan hingga publikasi hingga pemantauan.

Saat Anda mengedit atau menghapus dokumen, hal ini akan berdampak pada masa mendatang:

  • Jika mengedit dokumen, Anda perlu mengedit artefak terkait secara manual, termasuk proxy API dan produk API apa pun yang mengekspos resource-nya, serta membuat ulang dokumentasi referensi API untuk mencerminkan perubahan yang diterapkan dalam dokumen.
  • Jika menghapus dokumen, Anda harus menghapus artefak terkait secara manual, termasuk proxy API dan mengedit produk API apa pun untuk menghapus resource terkait, serta membuat ulang dokumentasi referensi API untuk mencerminkan penghapusan dokumen dan resource-nya.

Apa yang terjadi jika saya membuat proxy API dari dokumen OpenAPI?

Di Edge, Anda dapat membuat proxy API dari dokumen OpenAPI. Hanya dengan beberapa klik, Anda akan memiliki proxy API dengan jalur, parameter, alur bersyarat, dan endpoint target yang dibuat secara otomatis. Kemudian, Anda dapat menambahkan fitur seperti keamanan OAuth, pembatasan kapasitas, dan penyimpanan dalam cache.

Anda dapat membuat proxy API dari dokumen OpenAPI, seperti yang dijelaskan di bagian berikut:

Saat memublikasikan API, Anda akan mengambil snapshot dokumen OpenAPI untuk membuat dokumentasi referensi API. Snapshot tersebut mewakili revisi tertentu dari dokumen deskripsi di penyimpanan spesifikasi.