batnoter api
v1.0.0
นี่คือบริการ API ของแอปพลิเคชัน Batnoter ที่สร้างขึ้นด้วย Golang
มันเปิดเผยจุดสิ้นสุดของ REST ในการเข้าถึงและจัดการบันทึกย่อ Markdown จากที่เก็บ GIT ของผู้ใช้ ขณะนี้รองรับพื้นที่เก็บข้อมูลของ GitHub สำหรับการจัดเก็บและจัดการบันทึกย่อเท่านั้น
1.18 ขึ้นไปคำสั่งด้านล่างใช้ Docker เพื่อเริ่มคอนเทนเนอร์ฐานข้อมูล
make network
make postgres
make createdb config.yaml เป็นไฟล์เทมเพลตการกำหนดค่าที่มีค่ากำหนดค่าเริ่มต้น
cp config.yaml .config.yaml แอปพลิเคชันใช้ไฟล์. .config.yaml เพื่อรับค่าการกำหนดค่า โปรดอัปเดตค่า placeholder-values จากไฟล์กำหนดค่านี้ไปยังไฟล์จริง
ตรวจสอบให้แน่ใจว่าไฟล์ .config.yaml ได้รับการกำหนดค่าอย่างถูกต้องและคอนเทนเนอร์ฐานข้อมูลกำลังเปิดและทำงาน จากนั้นเรียกใช้คำสั่งด้านล่างเพื่อตั้งค่า DB Schema และเริ่มต้นเว็บเซิร์ฟเวอร์
go run main.go migrateup
go run main.go serve สิ่งนี้จะเริ่มต้นเซิร์ฟเวอร์บนพอร์ตที่ระบุในไฟล์. .config.yaml ตอนนี้คุณสามารถเข้าถึงจุดสิ้นสุด API
go test -v -cover ./...สิ่งนี้จะดำเนินการทดสอบทั้งหมดและพิมพ์เปอร์เซ็นต์การครอบคลุมรหัส
การบริจาคทุกครั้งสร้างความแตกต่าง
อ่านแนวทางการบริจาคก่อนที่คุณจะมีส่วนร่วม
