API Dökümantasyonu Hakkında
-
Dışarıya Açılacak 5-6 tane servis var bunlar için dökümantasyon yazmam istendi.
Referans olarak kullanılabilecek örnek dökümanlar var mı acaba kullandığınız?
Düz word'e yazıp pdf olarak dışarı aktarıyorum şuanda ama bu işler için daha efektif kullanışlı yöntemler var mıdır merak ettim.
-
Java'da Swagger kullaniyorduk hocam, bayagi da kullanisliydi. Ayni secenekler .net icin de var bildigim kadariyla. Ona bi baksana.
Edit:
JPriest tarafından 19/Eyl/23 14:04 tarihinde düzenlenmiştir
Evet varmis: https://code-maze.com/swagger-ui-asp-net-core-web-api/ -
gitbok
-
postman collectionu seklinde de yapabilirsin orada da dokumantasyon eklenebiliyor.
-
http://test.kodsedna.com/Agencydoc/ bu bizim dökümantasyon. bunu kullanıyoruz bi api üstünden çekilmiş proje.
bende tüm kaynağı var ama bizim, orjinal halini bulamadım proje içinde tarif ederseniz bulabilirim veya upload ederim kendin bulursun hocam.
-
redoc ve swagger en çok kullanılanları
-
cybermole bunu yazdı
gitbok
askfhsdlgsd şaka yapıyor zannetmiştim.
https://www.gitbook.com/pricing
edit: bu arada github'da bitane html döküman templatei var ben onu kullanıyorum genelde.
https://github.com/floriannicolas/API-Documentation-HTML-Template
-
https://apidocjs.com
-
readme.io
-
projen php ise otomatikleştirebilirsin onun için önereceğim kütüphane https://scribe.knuckles.wtf/laravel/ olucaktır. Bunu bayadır kullanıyoruz laravel ve lumen ile uyumlu controllerınların annotations kısmına yapıyı belirtirsen otomatik bir şekilde çıkarıyor. Önerim bunun gibi otomatize birşey yapman olucaktır yoksa her güncellemede orayıda güncellemen gerekicek buda hataya sebebiyet verecektir.
-
EnableTurk bunu yazdıcybermole bunu yazdı
gitbok
askfhsdlgsd şaka yapıyor zannetmiştim.
https://www.gitbook.com/pricing
edit: bu arada github'da bitane html döküman templatei var ben onu kullanıyorum genelde.
https://github.com/floriannicolas/API-Documentation-HTML-Template
o harfini unutmuşum oto klavye kapalı yazınca :)