BirdTouch WebAPI

Birdtouch-Webapi

Birdtouch-Webapi เป็นเซิร์ฟเวอร์ที่ใช้โดยแอพ BirdTouch Android

เซิร์ฟเวอร์เขียนใน. NET 5.0 โดยใช้ฐานข้อมูล PostgreSQL

ความต้องการ

• นักเทียบท่า
• นักเทียบท่า
• พอร์ต 4050 เป็นอิสระและไม่ได้ใช้งานโดยแอพใด ๆ บนเครื่องที่ Docker Daemon กำลังทำงานอยู่

การติดตั้ง

• กำหนดค่าไฟล์ .env (ดูส่วนการกำหนดค่า)
• เรียกใช้ docker-compose up -d จากรูทของ repo นี้
• เรียกใช้ docker-compose ps เพื่อตรวจสอบว่าบริการทั้งหมดเปิดใช้งานหรือไม่
  • หมายเหตุ: บริการ database-migration ควรอยู่ในสถานะ Exit 0
• ยินดีด้วย! WebAPI (พร้อมฐานข้อมูล) พร้อมใช้งานในพอร์ต 4050

[ไม่บังคับ] การย้ายฐานข้อมูล (อัปเกรด/สคริปต์ SQL ใหม่)

สคริปต์ SQL ทั้งหมดที่ใช้ในการสร้างฐานข้อมูลและเพื่อแทรกข้อมูลที่จำเป็นจะอยู่ในโฟลเดอร์การย้ายถิ่น

ในการเพิ่มสคริปต์ใหม่ที่กำหนดเองหรือดำเนินการอัพเกรดฐานข้อมูลโปรดทำตามขั้นตอนต่อไปนี้:

1. สร้างสคริปต์. sql ใหม่ตามอนุสัญญาการตั้งชื่อในโฟลเดอร์การย้ายถิ่น - แนวคิดคือสคริปต์ถูกจัดเรียงตามตัวอักษรเพื่อให้มีลำดับของการดำเนินการบางอย่าง

2. โปรดทราบว่าสคริปต์ที่ครั้งหนึ่งเคยดำเนินการจะไม่ถูกเรียกใช้อีกครั้งในฐานข้อมูลเดียวกัน (เพื่อตรวจสอบว่ามีการเรียกใช้สคริปต์ชื่อสคริปต์จะถูกใช้)

3. เมื่อคุณมีสคริปต์ที่จำเป็นทั้งหมดตอนนี้เพิ่มลงในโฟลเดอร์การย้ายถิ่นโปรดดำเนินการ:

   docker-compose up database-migration --build

การกำหนดค่า

การกำหนดค่าทั้งหมดทำได้โดยการแก้ไขไฟล์. ENV

• การเปลี่ยนแปลงที่แนะนำ:

  • อัปเดต POSTGRES_PASSWORD และสตริงการเชื่อมต่อที่ใช้ในการเข้าถึงฐานข้อมูล
  • อัปเดตรหัสผ่าน PGADMIN_DEFAULT_PASSWORD ที่ใช้สำหรับการเข้าถึงแอป PGADMIN
  • เปลี่ยน JWTSecurityKey ที่ใช้สำหรับการแฮชของโทเค็นการอนุญาต

• ไม่จำเป็น:

  • RemoveInactiveUsersRunEvery งานตามกำหนดเวลาที่จะตรวจสอบว่ามีผู้ใช้ที่ไม่ได้ใช้งาน
  • RemoveInactiveUsersRemoveUsersOlderThan ตั้งค่าจำนวนชั่วโมงของการไม่ใช้งานที่พิจารณาสำหรับผู้ใช้ที่จะอยู่ในสถานะที่ไม่ได้ใช้งาน

ดีที่จะรู้เฉพาะ

การได้รับที่อยู่ IP ของคอนเทนเนอร์ WSL2 Linux

หากคุณใช้ WSL2 บน Windows10 และมีคอนเทนเนอร์ Linux ที่คุณติดตั้ง Docker เพื่อเข้าถึง BirdTouch WebAPI (เช่นจากไคลเอนต์ BirdTouch ที่ทำงานบน Android Emulator) คุณต้องพบที่อยู่ IP ของ WSL2

ทำตามขั้นตอนต่อไปนี้:

1. เข้าสู่ระบบไปยังเครื่อง Linux ด้วย WSL2
2. ดำเนินการ ifconfig
3. ค้นหามูลค่า net ของ eth0: ตัวอย่างเช่นจะเป็น 172.22.200.173
4. ขอแสดงความยินดีตอนนี้คุณสามารถเข้าถึง birdtouch webapi ที่ทำงานบนคอนเทนเนอร์ WSL2 Linux ผ่าน 172.22.200.173:4050

หากคุณต้องการให้บริการ webapi จากพีซีของคุณ

1. ตรวจสอบว่าพอร์ตที่ WebAPI ทำงานได้หรือไม่ (ปกติ 4050) สามารถเข้าถึงได้ทั่วโลก:
2. ถ้าไม่กำหนดค่าให้เป็น! -
3. [ไม่บังคับ] ไซต์ NOIP.com มีเครื่องมือ DUC ที่ซิงโครไนซ์ที่อยู่ IP แบบไดนามิกของคุณกับชื่อโฮสต์บางอย่างด้วยวิธีนี้คุณสามารถโฮสต์อะไรก็ได้จากพีซีในพื้นที่ของคุณและไม่ต้องกังวลกับการเปลี่ยนแปลงที่อยู่ IP