Go'da main.go Programını Çalıştırmak

Tolga — Tue, 06 Feb 2024 06:43:40 +0000

Go programını çalıştırmak için aşağıdaki adımları izleyin:

Ön Koşullar

Go'nun bilgisayarınıza kurulu olması gerekir. Kurulum için Go'nun resmi web sitesini ziyaret edin.

Adım 1: Programınızın Bulunduğu Dizine Gitmek

Terminal veya komut istemcisini açın ve Go programınızın bulunduğu dizine gidin.

cd go/goinittestapi/application/cmd/server

programınızın bilgisayarınızdaki konumuna göre değişiklik gösterir.

Adım 2: Programı Çalıştırmak

Programınızın bulunduğu dizinde, aşağıdaki go run komutunu kullanarak Go programınızı çalıştırın.

go run main.go

Adım 3: Programı Derlemek ve Çalıştırılabilir Dosya Oluşturmak

Programınızı derleyerek bir çalıştırılabilir dosya oluşturmak için go build komutunu kullanın.

go build main.go

Bu, main (Windows'ta main.exe) adında bir çalıştırılabilir dosya oluşturur. Daha sonra bu dosyayı doğrudan çalıştırabilirsiniz.

Linux veya macOS'te:

./main

Go Dilinde Swagger Dokümantasyonu Oluşturma

Tolga — Tue, 06 Feb 2024 05:57:33 +0000

Go dilinde API geliştirirken, API'nizin nasıl kullanılacağına dair net bir dokümantasyon sağlamak önemlidir. Swagger (şimdi OpenAPI olarak da bilinir), API'lerinizi tanımlamanın, oluşturmanın, belgelemenin ve kullanmanın standart bir yolunu sunar. Bu yazıda, Go'da Swagger dokümantasyonu nasıl oluşturulur ve projenize nasıl entegre edilir adım adım anlatılacaktır.

Adım 1: Swag CLI Kurulumu

İlk adım olarak, swag CLI aracını kurarak başlayalım. Bu araç, Go projenizdeki yorumları okuyup otomatik olarak Swagger dokümantasyonu oluşturacak.

go get -u github.com/swaggo/swag/cmd/swag

Adım 2: API Yorum Satırlarını Yazma

Dokümantasyonunuzu otomatik olarak oluşturabilmek için, API handler fonksiyonlarınıza özel yorum satırları eklemeniz gerekiyor. Bu yorumlar, swag'ın dokümantasyonunuzu oluştururken kullanacağı meta verileri sağlar.

// GetUser godoc
// @Summary Kullanıcı detaylarını getirir
// @Description Kullanıcı detaylarını ID'ye göre getirir
// @Tags users
// @Accept  json
// @Produce  json
// @Param   id     path    int     true        "User ID"
// @Success 200 {object} User
// @Router /users/{id} [get]
func GetUser(w http.ResponseWriter, r *http.Request) {
    // Handler logic here
}

Adım 3: Swagger Dokümantasyonunu Oluşturma

Kodunuzdaki yorum satırlarına dayanarak Swagger dokümantasyonunu oluşturmak için projenizin kök dizininde swag init komutunu çalıştırın.

swag init -d ./application/cmd/server,./application/app/controllers/ilanlar,./application/app/controllers/ihaleler,./application/app/controllers/teklifler,./application/app/controllers/kullanicilar --parseDependency --parseInternal

Bu komut, docs dizini altında Swagger dokümantasyon dosyalarını (swagger.json, swagger.yaml ve docs.go) oluşturur.

Adım 4: Swagger UI Entegrasyonu

Oluşturulan Swagger dokümantasyonunu bir web arayüzünde görüntülemek için swaggo/http-swagger paketini projenize dahil edin. Bu paket, Swagger UI'ı Go web uygulamanıza entegre etmenizi sağlar.

import "github.com/swaggo/http-swagger" // http-swagger middleware

// Serve the swagger UI
http.Handle("/swagger", httpSwagger.WrapHandler)

Adım 5: Sunucuyu Başlatma ve Dokümantasyonu Görüntüleme

Sunucunuzu başlattıktan sonra, http://localhost:7706/swagger/index.html adresine giderek Swagger UI üzerinden API dokümantasyonunuzu görüntüleyebilirsiniz.

DEV Community: Tolga