Membangun GraphQL dengan APIs RDS introspeksi - AWS AppSync

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

Membangun GraphQL dengan APIs RDS introspeksi

AWS AppSync utilitas introspeksi dapat menemukan model dari tabel database dan mengusulkan tipe GraphQL. APIWisaya Buat AWS AppSync konsol dapat langsung menghasilkan API dari database Aurora My SQL atau SQL Postgre. Secara otomatis membuat jenis dan JavaScript resolver untuk membaca dan menulis data.

AWS AppSync menyediakan integrasi langsung dengan database Amazon Aurora melalui Data Amazon. RDS API Alih-alih memerlukan koneksi database persisten, Amazon RDS Data API menawarkan HTTP titik akhir aman yang AWS AppSync terhubung ke untuk menjalankan SQL pernyataan. Anda dapat menggunakan ini untuk membuat database relasional API untuk SQL beban kerja My SQL dan Postgre Anda di Aurora.

APIMembangun database relasional Anda dengan AWS AppSync memiliki beberapa keuntungan:

  • Database Anda tidak langsung terpapar ke klien, memisahkan titik akses dari database itu sendiri.

  • Anda dapat membangun purpose-built yang APIs disesuaikan dengan kebutuhan aplikasi yang berbeda, menghilangkan kebutuhan akan logika bisnis khusus di frontend. Ini sejajar dengan pola Backend-For-Frontend (BFF).

  • Otorisasi dan kontrol akses dapat diimplementasikan pada AWS AppSync lapisan menggunakan berbagai mode otorisasi untuk mengontrol akses. Tidak ada sumber daya komputasi tambahan yang diperlukan untuk terhubung ke database, seperti hosting server web atau koneksi proxy.

  • Kemampuan real-time dapat ditambahkan melalui langganan, dengan mutasi data yang dilakukan AppSync secara otomatis didorong ke klien yang terhubung.

  • Klien dapat terhubung ke API over HTTPS menggunakan port umum seperti 443.

AWS AppSync membuat membangun APIs dari database relasional yang ada menjadi mudah. Utilitas introspeksi dapat menemukan model dari tabel database dan mengusulkan tipe GraphQL. APIWisaya Buat AWS AppSync konsol dapat langsung menghasilkan API dari database Aurora My SQL atau SQL Postgre. Secara otomatis membuat jenis dan JavaScript resolver untuk membaca dan menulis data.

AWS AppSync menyediakan JavaScript utilitas terintegrasi untuk menyederhanakan SQL pernyataan penulisan dalam resolver. Anda dapat menggunakan AWS AppSync templat sql tag untuk pernyataan statis dengan nilai dinamis, atau utilitas rds modul untuk membangun pernyataan secara terprogram. Lihat referensi fungsi resolver untuk sumber RDS data dan modul bawaan untuk informasi selengkapnya.

Menggunakan fitur introspeksi (konsol)

Untuk tutorial terperinci dan panduan memulai, lihat Tutorial: Aurora Postgre SQL Tanpa Server dengan Data. API

AWS AppSync Konsol memungkinkan Anda membuat AWS AppSync API GraphQL dari database Aurora yang ada yang dikonfigurasi dengan API Data hanya dalam beberapa menit. Ini dengan cepat menghasilkan skema operasional berdasarkan konfigurasi database Anda. Anda dapat menggunakan API apa adanya atau membangunnya untuk menambahkan fitur.

  1. Masuk ke AWS Management Console dan buka AppSynckonsol.

    1. Di Dasbor, pilih Buat API.

  2. Di bawah APIopsi, pilih APIsGraphQL, Mulai dengan cluster Amazon Aurora, lalu Berikutnya.

    1. Masukkan APInama. Ini akan digunakan sebagai pengidentifikasi untuk API di konsol.

    2. Untuk detail kontak, Anda dapat memasukkan titik kontak untuk mengidentifikasi manajer untukAPI. Ini adalah bidang opsional.

    3. Di bawah APIKonfigurasi pribadi, Anda dapat mengaktifkan API fitur pribadi. Private hanya API dapat diakses dari VPC endpoint (VPCE) yang dikonfigurasi. Untuk informasi selengkapnya, lihat Pribadi APIs.

      Kami tidak menyarankan mengaktifkan fitur ini untuk contoh ini. Pilih Berikutnya setelah meninjau input Anda.

  3. Di halaman Database, pilih Pilih database.

    1. Anda harus memilih database Anda dari cluster Anda. Langkah pertama adalah memilih Wilayah tempat cluster Anda berada.

    2. Pilih cluster Aurora dari daftar drop-down. Perhatikan bahwa Anda harus telah membuat dan mengaktifkan data yang sesuai API sebelum menggunakan sumber daya.

    3. Selanjutnya, Anda harus menambahkan kredensil untuk database Anda ke layanan. Ini terutama dilakukan dengan menggunakan AWS Secrets Manager. Pilih Wilayah di mana rahasia Anda ada. Untuk informasi selengkapnya tentang cara mengambil informasi rahasia, lihat Menemukan rahasia atau Mengambil rahasia.

    4. Tambahkan rahasia Anda dari daftar drop-down. Perhatikan bahwa pengguna harus memiliki izin membaca untuk database Anda.

  4. Pilih Impor.

    AWS AppSync akan mulai introspeksi database Anda, menemukan tabel, kolom, kunci utama, dan indeks. Ini memeriksa bahwa tabel yang ditemukan dapat didukung dalam GraphQLAPI. Perhatikan bahwa untuk mendukung pembuatan baris baru, tabel memerlukan kunci utama, yang dapat menggunakan beberapa kolom. AWS AppSync memetakan kolom tabel untuk mengetik bidang sebagai berikut:

    Tipe data Jenis bidang
    VARCHAR String
    CHAR String
    BINARY String
    VARBINARY String
    TINYBLOB String
    TINYTEXT String
    TEXT String
    BLOB String
    MEDIUMTEXT String
    MEDIUMBLOB String
    LONGTEXT String
    LONGBLOB String
    BOOL Boolean
    BOOLEAN Boolean
    BIT Int
    TINYINT Int
    SMALLINT Int
    MEDIUMINT Int
    INT Int
    INTEGER Int
    BIGINT Int
    YEAR Int
    FLOAT Desimal
    DOUBLE Desimal
    DECIMAL Desimal
    DEC Desimal
    NUMERIC Desimal
    DATE AWSDate
    TIMESTAMP String
    DATETIME String
    TIME AWSTime
    JSON AWSJson
    ENUM ENUM
  5. Setelah penemuan tabel selesai, bagian Database akan diisi dengan informasi Anda. Di bagian tabel Database baru, data dari tabel mungkin sudah diisi dan dikonversi menjadi tipe untuk skema Anda. Jika Anda tidak melihat beberapa data yang diperlukan, Anda dapat memeriksanya dengan memilih Tambahkan tabel, mengklik kotak centang untuk jenis tersebut di modal yang muncul, lalu memilih Tambah.

    Untuk menghapus tipe dari bagian tabel Database, klik kotak centang di sebelah jenis yang ingin Anda hapus, lalu pilih Hapus. Jenis yang dihapus akan ditempatkan di modal Tambahkan tabel jika Anda ingin menambahkannya lagi nanti.

    Perhatikan bahwa AWS AppSync menggunakan nama tabel sebagai nama tipe, tetapi Anda dapat mengganti nama mereka - misalnya, mengubah nama tabel jamak seperti movies ke nama tipe Movie. Untuk mengganti nama tipe di bagian tabel Database, klik kotak centang dari jenis yang ingin Anda ganti nama, lalu klik ikon pensil di kolom Type name.

    Untuk melihat pratinjau konten skema berdasarkan pilihan Anda, pilih skema pratinjau. Perhatikan bahwa skema ini tidak dapat kosong, jadi Anda harus memiliki setidaknya satu tabel yang dikonversi menjadi tipe. Juga, skema ini tidak boleh melebihi 1 MB dalam ukuran.

    1. Di bawah Peran layanan, pilih apakah akan membuat peran layanan baru khusus untuk impor ini atau menggunakan peran yang ada.

  6. Pilih Berikutnya.

  7. Selanjutnya, pilih apakah akan membuat read-only API (hanya kueri) atau API untuk membaca dan menulis data (dengan kueri dan mutasi). Yang terakhir ini juga mendukung langganan real-time yang dipicu oleh mutasi.

  8. Pilih Berikutnya.

  9. Tinjau pilihan Anda dan kemudian pilih Buat API. AWS AppSync akan membuat API dan melampirkan resolver ke kueri dan mutasi. Yang API dihasilkan beroperasi penuh dan dapat diperpanjang sesuai kebutuhan.

Menggunakan fitur introspeksi () API

Anda dapat menggunakan StartDataSourceIntrospection introspeksi API untuk menemukan model dalam database Anda secara terprogram. Untuk detail lebih lanjut tentang perintah, lihat menggunakan StartDataSourceIntrospectionAPI.

Untuk menggunakanStartDataSourceIntrospection, berikan klaster Aurora Anda Amazon Resource Name (ARN), nama database, dan AWS Secrets Manager rahasia. ARN Perintah memulai proses introspeksi. Anda dapat mengambil hasilnya dengan GetDataSourceIntrospection perintah. Anda dapat menentukan apakah perintah harus mengembalikan string Storage Definition Language (SDL) untuk model yang ditemukan. Ini berguna untuk menghasilkan definisi SDL skema langsung dari model yang ditemukan.

Misalnya, jika Anda memiliki pernyataan Data definition language (DDL) berikut untuk Todos tabel sederhana:

create table if not exists public.todos ( id serial constraint todos_pk primary key, description text, due timestamp, "createdAt" timestamp default now() );

Anda memulai introspeksi dengan yang berikut ini.

aws appsync start-data-source-introspection \ --rds-data-api-config resourceArn=<cluster-arn>,secretArn=<secret-arn>,databaseName=database

Selanjutnya, gunakan GetDataSourceIntrospection perintah untuk mengambil hasilnya.

aws appsync get-data-source-introspection \ --introspection-id a1234567-8910-abcd-efgh-identifier \ --include-models-sdl

Ini mengembalikan hasil sebagai berikut.

{ "introspectionId": "a1234567-8910-abcd-efgh-identifier", "introspectionStatus": "SUCCESS", "introspectionStatusDetail": null, "introspectionResult": { "models": [ { "name": "todos", "fields": [ { "name": "description", "type": { "kind": "Scalar", "name": "String", "type": null, "values": null }, "length": 0 }, { "name": "due", "type": { "kind": "Scalar", "name": "AWSDateTime", "type": null, "values": null }, "length": 0 }, { "name": "id", "type": { "kind": "NonNull", "name": null, "type": { "kind": "Scalar", "name": "Int", "type": null, "values": null }, "values": null }, "length": 0 }, { "name": "createdAt", "type": { "kind": "Scalar", "name": "AWSDateTime", "type": null, "values": null }, "length": 0 } ], "primaryKey": { "name": "PRIMARY_KEY", "fields": [ "id" ] }, "indexes": [], "sdl": "type todos\n{\ndescription: String\n\ndue: AWSDateTime\n\nid: Int!\n\ncreatedAt: AW SDateTime\n}\n" } ], "nextToken": null } }