Insomnia ile API Dokümanı Oluşturmak

Insomnia ile API Dokümanı Oluşturmak 2

Insomnia ile API dokümanı oluşturmak için insomnia-documenter paketi kullanacağız, öncesinde kısaca REST API, Insomnia dan bahsedelim.

REST API Nedir?

  • REST(REpresentational State Transfer) kısaltılmış halidir.
  • REST sistemlere bir standart getirerek birbirleriyle haberleşmesini kolaylaştırır.
  • REST web servis oluşturmak için kullanılan bir yöntemdir.
  • REST HTTP protokolünü kullanarak gelen isteklere JSON, XML vb. yapılar ile cevap verir.
  • HTTP üzerinde çalıştığı için hızlıdır.

Insomnia Nedir?

Insomnia API nizi dizayn etmenize yarayan bir araçtır, bu araç ile oluşturduğunuz API nizi örnek istekler oluşturarak test edebilirsiniz. Insomnia nın bize sunduğu birçok özellik API mizi daha kolay yönetebilmemizi sağlar.

  • İstekleri gruplayabilir, çevresel değişkenler(environment variables) tanımlayabilirsiniz.
  • Dönen response ları detaylı bir şekilde inceleyebilirsiniz.
  • Birden fazla proje için workspace ler oluşturabilirsiniz.

Daha detaylı bilgi için sitesinden özelliklerini incelyebilirsiniz.

Gerekli Araçlar

Insomnia Dokümanlaştırma

Insomnia ile API dokümanı oluşturmak için demoyu indirip Insomnia import edelim.

Insomnia ile API dokümanı oluşturmak
Insomnia ile API Dokümanı Oluşturmak 3

Burdan “From File” diyerek indirdiğiniz demo dosyasını import edebilirsiniz.

Import işleminden sonra artık dokümanımızı istediğimiz gibi değiştirebiliriz örneğin workspace deki açıklamayı güncellemek için ayarlar kısmından “Workspace Settings” kısmına tıklayın

Insomnia ile API Dokümanı Oluşturmak 4

Daha sonra “Write” kısmına tıklayarak markdown formatında açıklamaları düzenleyebilir, “Preview” kısmında görüntüleyebilirsiniz.

Insomnia ile API Dokümanı Oluşturmak 5

İsteklerle ilgili açıklamaları isteğe tıklayıp “Docs” kısmından “Edit” tıklayıp, düzenleyebilirsiniz.

Insomnia ile API Dokümanı Oluşturmak 6

Query kısmına tıklayarak parametrelere açıklama girebilirsiniz.

Insomnia ile API Dokümanı Oluşturmak 7

Açıklamaları istediğimiz gibi düzenledikten sonra export alıp güncel halini çalıştıralım. Bu kısımla ilgili youtubedaki videoyu izleyebilirsiniz.

Export Data ya tıklayıp Current Workspace i seçebiliriz.

Insomnia ile API Dokümanı Oluşturmak 8

Burdan dokümandan çıkarmak istediğimiz istekleri kaldırabiliriz, daha sonra Export diyerek JSON formatıda bilgisayara kaydedelim.

Insomnia ile API Dokümanı Oluşturmak 9

Done diyerek bilgisayarda istediğimiz kısma kaydedelim.

Insomnia ile API Dokümanı Oluşturmak 10

Daha sonra console(terminal) den kaydettiğimiz kısımda aşağıdaki komutu çalıştıralım.

npx insomnia-documenter --config Insomnia_2020-04-30.json --output insomnia-demo

Bu komut insomnia-demo adlı dosyanın içine gerekli dosyaları oluşturacak, daha sonra o dizine geçip aşağıdaki komutu çalıştırabilirsiniz.

npx serve
Insomnia ile API Dokümanı Oluşturmak 11

Sonuç

Insomnia size birden fazla dilde örnek barındıran bir dokümantasyon sağlayacaktır. Bulutfon için oluşturduğumuz API dokümantasyonu yazımızı inceleyebilirsiniz

Leave a Comment

E-posta hesabınız yayımlanmayacak. Gerekli alanlar * ile işaretlenmişlerdir

Scroll to Top