apihub

freeapi.app

ปัญหา

เรากำลังพยายามสร้างฮับ API แหล่งเดียวที่สามารถใช้เพื่อเรียนรู้การจัดการ API ในภาษาการเขียนโปรแกรมใด ๆ ผู้ใช้สามารถสร้างพอร์ตโฟลิโอส่วนหน้าในเว็บและแอพมือถือโดยใช้ฮับ API นี้

freeapi.app คืออะไร

โครงการ Freeapi เป็นโครงการริเริ่มที่เป็นนวัตกรรมและขับเคลื่อนด้วยชุมชนที่มีวัตถุประสงค์เพื่อให้นักพัฒนาซอฟต์แวร์มี API ฟรีและเข้าถึงได้สำหรับโครงการของพวกเขา

โครงการมุ่งเน้นไปที่การส่งมอบ API ที่หลากหลายซึ่งรองรับโดเมนและฟังก์ชันต่าง ๆ ทำให้นักพัฒนาสามารถรวม API เหล่านี้เข้ากับแอปพลิเคชันได้อย่างราบรื่น

ไฮไลท์ที่สำคัญของโครงการ Freeapi ได้แก่ :

1. การเข้าถึง: โครงการ Freeapi มุ่งมั่นที่จะกำจัดอุปสรรคโดยให้การเข้าถึงคอลเลกชันของ API ฟรี นักพัฒนาสามารถใช้ประโยชน์จาก API เหล่านี้โดยไม่มีข้อ จำกัด ด้านต้นทุนใด ๆ ช่วยให้พวกเขาทดลองเรียนรู้และสร้างแอพพลิเคชั่นที่เป็นนวัตกรรม

2. คอลเลกชัน API ที่หลากหลาย: โครงการนำเสนอคอลเล็กชั่น API ที่หลากหลายและครอบคลุมซึ่งครอบคลุมทั่วทั้งอุตสาหกรรมโดเมนและฟังก์ชันการทำงานที่แตกต่างกัน ไม่ว่าคุณจะต้องการการบูรณาการสื่อสังคมออนไลน์เกตเวย์การชำระเงินอัลกอริทึมการเรียนรู้ของเครื่องหรือการเชื่อมต่ออุปกรณ์ IoT โครงการ FreeAPI ได้ครอบคลุม

3. การบูรณาการแบบง่าย ๆ : โครงการ Freeapi เข้าใจถึงความท้าทายที่นักพัฒนาเผชิญเมื่อรวม APIs เข้ากับแอปพลิเคชันของพวกเขา ในการแก้ไขปัญหานี้โครงการจัดทำเอกสารที่ชัดเจนตัวอย่างโค้ดและ SDKS ทำให้กระบวนการรวมและลดเวลาและความพยายามในการพัฒนาง่ายขึ้น

4. การพัฒนาที่ขับเคลื่อนด้วยชุมชน: โครงการส่งเสริมชุมชนที่มีชีวิตชีวาและร่วมมือกันของนักพัฒนา ผู้มีส่วนร่วมได้รับการสนับสนุนให้แบ่งปันความรู้มีส่วนร่วมในการอภิปรายและทำงานร่วมกันในโครงการที่เกี่ยวข้องกับ API ความพยายามร่วมกันนี้ช่วยให้มั่นใจได้ว่าการปรับปรุงและความน่าเชื่อถืออย่างต่อเนื่องของ API ที่เสนอโดยโครงการ Freeapi

5. การเรียนรู้และการพัฒนาทักษะ: โครงการ FreeAPI มีจุดมุ่งหมายเพื่อเสริมสร้างศักยภาพของนักพัฒนาโดยการจัดหาแพลตฟอร์มสำหรับการเรียนรู้และการพัฒนาทักษะ ผ่านการเข้าถึง APIs และทรัพยากรการศึกษาที่หลากหลายนักพัฒนาสามารถเพิ่มความเข้าใจในการบูรณาการ API ขยายความรู้และแสดงความเชี่ยวชาญของพวกเขาผ่านการสร้างโครงการที่สมบูรณ์

โดยรวมแล้วโครงการ Freeapi เป็นทรัพยากรที่มีค่าสำหรับนักพัฒนาที่ต้องการ API ที่เข้าถึงได้และหลากหลาย

ด้วยการอุปถัมภ์ชุมชนที่ให้การสนับสนุนโครงการช่วยให้นักพัฒนาสามารถเรียนรู้สร้างและคิดค้นนวัตกรรมในที่สุดก็มีส่วนช่วยในการเติบโตและความก้าวหน้าของภูมิทัศน์การรวม API

คุณสมบัติ:

แนะนำโครงการ API Hub โอเพ่นซอร์สที่ก้าวล้ำของเราซึ่งเป็นแพลตฟอร์มแบบไดนามิกที่ออกแบบมาเพื่อปฏิวัติวิธีที่นักพัฒนาโต้ตอบกับ APIs

ด้วยการเน้นไปที่การเปิดกว้างการเข้าถึงและการเรียนรู้ฮับ API ของเราช่วยให้นักพัฒนาทุกระดับในการสำรวจทดลองและพัฒนาทักษะในการบูรณาการ API

ไฮไลท์:

1. โอเพ่นซอร์ส: ฮับ API ของเราสร้างขึ้นบนหลักการของโอเพ่นซอร์สเพื่อให้มั่นใจถึงความโปร่งใสการทำงานร่วมกันและการพัฒนาที่ขับเคลื่อนด้วยชุมชน ซึ่งหมายความว่าซอร์สโค้ดมีให้บริการอย่างอิสระช่วยให้นักพัฒนาสามารถปรับแต่งขยายและมีส่วนร่วมในโครงการ

2. ใช้งานได้ฟรี: เราเชื่อมั่นในการกำจัดอุปสรรคในการเข้าซึ่งเป็นสาเหตุที่ฮับ API ของเราใช้งานได้ฟรี ไม่ว่าคุณจะเป็นนักพัฒนาที่มีประสบการณ์หรือเพิ่งเริ่มต้นการเดินทางการเข้ารหัสคุณสามารถใช้ประโยชน์จากแพลตฟอร์มของเราโดยไม่มีข้อ จำกัด ด้านต้นทุนใด ๆ

3. ท้องถิ่นหรือการปรับใช้ : ความยืดหยุ่นเป็นหัวใจสำคัญของฮับ API ของเรา คุณมีตัวเลือกในการใช้งานในเครื่องทำงานบนเครื่องของคุณเองหรือปรับใช้กับเซิร์ฟเวอร์ทำให้ผู้อื่นสามารถเข้าถึงได้ ความเก่งกาจนี้ช่วยให้มั่นใจได้ว่าคุณสามารถปรับแพลตฟอร์มให้เข้ากับสภาพแวดล้อมการพัฒนาเฉพาะของคุณ

4. แหล่งข้อมูลการเรียนรู้ : ศูนย์กลาง API ของเราได้รับการออกแบบให้เป็นแหล่งเรียนรู้ที่ครอบคลุมนำเสนอสื่อการศึกษาบทเรียนและเอกสารประกอบ ไม่ว่าคุณจะเป็นผู้เริ่มต้นหรือพยายามที่จะขยายความรู้ API ของคุณแพลตฟอร์มของเราให้ทรัพยากรที่คุณต้องการในการเรียนรู้และปรับปรุง

5. จุดสิ้นสุดที่กำหนดเองสำหรับผู้เริ่มต้น : สำหรับนักพัฒนาในระดับเริ่มต้น API Hub ของเรานำเสนอจุดสิ้นสุดที่กำหนดเองที่ให้ประสบการณ์ในการจัดการการตอบสนอง API API ที่เป็นมิตรกับผู้เริ่มต้นเหล่านี้ช่วยให้คุณฝึกฝนและทำความคุ้นเคยกับพื้นฐานของการทำงานกับ APIs

6. API ขั้นสูงสำหรับการสร้างพอร์ตโฟลิโอ : นอกเหนือจากจุดสิ้นสุดระดับเริ่มต้น API Hub ของเรายังให้ API ขั้นสูงเพื่อท้าทายและยืดทักษะของคุณ API เหล่านี้ช่วยให้คุณสามารถจัดการกับสถานการณ์การรวมที่ซับซ้อนมากขึ้นช่วยให้คุณสร้างผลงานโครงการที่แข็งแกร่งเพื่อแสดงความเชี่ยวชาญของคุณ

ด้วยการรวมหลักการโอเพ่นซอร์สการเข้าถึงและการมุ่งเน้นไปที่การเรียนรู้โครงการ API Hub ของเราปูทางให้นักพัฒนาประสบความสำเร็จในโลกแห่งการรวม API เข้าร่วมชุมชนที่มีชีวิตชีวาของเราและเริ่มต้นการเดินทางที่น่าตื่นเต้นของการค้นพบการเติบโตและนวัตกรรม

หมายเหตุสำคัญ: การหลีกเลี่ยงการสูญเสียข้อมูลและการโฮสต์ตนเอง

ความเป็นมา:

ปัจจุบันโครงการโอเพนซอร์ซของเราโฮสต์บนเซิร์ฟเวอร์ระยะไกลซึ่งเราถูกบังคับให้รีเซ็ตเซิร์ฟเวอร์ทั้งหมด รวมถึงระบบไฟล์และฐานข้อมูล MongoDB ทุก 2 ชั่วโมง เพื่อหลีกเลี่ยงค่าใช้จ่ายเพิ่มเติม

กระบวนการนี้ส่งผลให้ การลบไฟล์รูปภาพ/คงที่ทั้งหมดและการรีเซ็ตฐานข้อมูลทั้งหมดบนเซิร์ฟเวอร์

สิ่งนี้หมายความว่าอย่างไรสำหรับคุณ?

การสูญเสียข้อมูล: การเปลี่ยนแปลงใด ๆ ที่เกิดขึ้นในช่วงเวลา 2 ชั่วโมง (บนเซิร์ฟเวอร์ระยะไกล) รวมถึงรูปภาพที่อัปโหลดและข้อมูลผู้ใช้จะหายไปและไม่สามารถกู้คืนได้

การหยุดชะงักของบริการ: การรีเซ็ตเซิร์ฟเวอร์อาจขัดขวางกระบวนการพัฒนาและทดสอบของคุณในช่วงเวลาที่กำหนดในขณะที่เซิร์ฟเวอร์กำลังรีบูต (เป็นเวลา 1-2 นาที)

โซลูชั่นที่แนะนำ:

การใช้ API ในท้องถิ่น: เพื่อการพัฒนาและทดสอบเราขอแนะนำอย่างยิ่งให้ใช้ API ในเครื่องบนเครื่องของคุณโดย การโคลนนิ่งโครงการ

สิ่งนี้ทำให้มั่นใจได้ว่างานของคุณจะไม่ได้รับผลกระทบจากการรีเซ็ตเซิร์ฟเวอร์และช่วยให้คุณรักษาสภาพแวดล้อมการพัฒนาที่มีเสถียรภาพในเครื่องในเครื่องของคุณ

การโฮสต์ตนเองบนทางรถไฟ (แนะนำสำหรับโครงการส่วนบุคคล) : เพื่อโฮสต์แอปพลิเคชัน Freeapi.app คุณสามารถใช้ประโยชน์จากเทมเพลตที่สร้างไว้ล่วงหน้าซึ่งพร้อมใช้งาน คลิกที่นี่เพื่อดูเอกสารโดยละเอียด

- การติดตั้ง

- ใช้ Docker (แนะนำ)

ในการเรียกใช้โครงการ Freeapi ให้ทำตามขั้นตอนเหล่านี้:

1. ติดตั้ง Docker บนเครื่องของคุณ
2. โคลนพื้นที่เก็บข้อมูลโครงการ
3. นำทางไปยังไดเรกทอรีโครงการ
4. สร้างไฟล์ .env ในโฟลเดอร์รูทและคัดลอกวางเนื้อหาของ .env.sample และเพิ่มข้อมูลรับรองที่จำเป็น
5. เรียกใช้คำสั่ง Docker Compose:

docker-compose up --build --attach backend

# --build: Rebuild the image and run the containers
# --attach: only show logs of Node app container and not mongodb

6. เข้าถึงโครงการ APIs ที่จุดสิ้นสุดที่ระบุ

ทำงานในพื้นที่

ในการเรียกใช้โครงการ Freeapi ในพื้นที่ให้ทำตามขั้นตอนเหล่านี้:

1. ติดตั้งเส้นด้าย, NodeJS, MongoDB และ MongoDB Compass (ไม่บังคับ) บนเครื่องของคุณ
2. โคลนพื้นที่เก็บข้อมูลโครงการ
3. นำทางไปยังไดเรกทอรีโครงการ
4. สร้างไฟล์ .env ในโฟลเดอร์รูทและคัดลอกวางเนื้อหาของ .env.sample และเพิ่มข้อมูลรับรองที่จำเป็น
5. ติดตั้งแพ็คเกจ:

yarn install

6. เรียกใช้โครงการ:

yarn start

7. เข้าถึงโครงการ APIs ที่จุดสิ้นสุดที่ระบุ

- การใช้ทางรถไฟ (การปรับใช้ครั้งเดียว)

ในการโฮสต์แอปพลิเคชัน Freeapi.app คุณสามารถใช้ประโยชน์จากเทมเพลตที่สร้างไว้ล่วงหน้าซึ่งพร้อมใช้งาน

1. คลิกปุ่มด้านบนเพื่อเยี่ยมชมทางรถไฟ

2. คลิกที่ปุ่ม ปรับใช้ตอนนี้

3. (ไม่บังคับ) ลงชื่อเข้าใช้กับ GitHub เพื่อปรับใช้

4. กรอกรายละเอียดที่เก็บ:

   • ระบุชื่อ repo (เช่น freeapi-app)
   • เครื่องหมายถูกสำหรับที่เก็บข้อมูลสาธารณะ/ส่วนตัว

5. สำหรับตัวแปรสภาพแวดล้อมเราได้จัดหาค่าเริ่มต้นบางอย่างใน ENV เพื่อลดภาระ แต่พารามิเตอร์บางอย่างเป็นข้อบังคับ:

   • PORT : อย่าเปลี่ยนค่าให้ตั้งค่าเป็น 8080 เพื่อดูเอกสาร Swagger หลังจากการปรับใช้
   • MONGODB_URI : ให้ URL ฐานข้อมูล MongoDB ATLAS ตัวอย่างถูกเติมไว้ล่วงหน้าสำหรับคุณแก้ไข/อัปเดตเพื่อดำเนินการต่อ
   • NODE_ENV : ตั้งค่าเริ่มต้นเป็น 'การพัฒนา' เพื่อดูบันทึก คุณอาจเลือกที่จะเปลี่ยนเป็น 'การผลิต' (ตรวจสอบให้แน่ใจว่าได้เพิ่มคำเดียวกันที่แน่นอน) เพื่อซ่อน
   • EXPRESS_SESSION_SECRET : ขอแนะนำให้เปลี่ยนค่าเริ่มต้นเป็นค่าลับของคุณเอง
   • ACCESS_TOKEN_SECRET : ขอแนะนำให้เปลี่ยนค่าเริ่มต้นเป็นค่าลับของคุณเอง
   • ACCESS_TOKEN_EXPIRY : ตั้งค่าเป็น 1 วันเป็นค่าเริ่มต้น
   • REFRESH_TOKEN_SECRET : ขอแนะนำให้เปลี่ยนค่าเริ่มต้นเป็นค่าลับของคุณเอง
   • REFRESH_TOKEN_EXPIRY : ตั้งค่าเป็น 10 วันเป็นค่าเริ่มต้น
   • FREEAPI_HOST_URL : ตั้งค่าเป็น URL ทางรถไฟที่สร้างขึ้น

6. เมื่อคุณกรอกพารามิเตอร์สภาพแวดล้อมที่จำเป็นหากคุณเลือกที่จะเพิ่มผู้อื่นเช่น PayPal, Google และ Razorpay โปรดดำเนินการต่อเพื่อพูดถึงข้อมูลประจำตัวของคุณในแบบฟอร์ม

7. คลิกที่ปุ่ม ปรับใช้ เพื่อทริกเกอร์บิลด์แรก

   • ตรวจสอบบันทึกเซิร์ฟเวอร์ หากคุณเจอปัญหาการปรับใช้ใด ๆ อย่าลังเลที่จะยกปัญหาให้ทีมของเราพิจารณา

หมายเหตุ: เมื่อมีการปรับใช้แอปพลิเคชันโปรดรอ 3-5 นาทีเพื่อให้เอกสาร Swagger พร้อมใช้งาน

- การทดสอบ

เพื่อให้แน่ใจว่าความน่าเชื่อถือและความมั่นคงสำหรับผู้ใช้ของเราเราใช้ Playwright ซึ่งเป็นกรอบการทดสอบที่ทรงพลังในการทดสอบโดยอัตโนมัติในทุกจุดสิ้นสุด

เรียกใช้เซิร์ฟเวอร์ทดสอบ

ตรวจสอบให้แน่ใจว่าได้เพิ่ม MONGO_MEMORY_SERVER_PORT=10000 (พอร์ต MongoDB สำหรับการทดสอบ E2E) ในไฟล์. .env ของคุณ

yarn start:test-server

- เรียกใช้การทดสอบ

yarn test:playwright

สิ่งนี้จะสร้างรายงานนักเขียนบทละคร เพื่อดูรายงานนี้เรียกใช้คำสั่งต่อไปนี้

yarn playwright show-report

ตรวจสอบให้แน่ใจว่ากรณีทดสอบทั้งหมดจะถูกส่งผ่านเมื่อใดก็ตามที่คุณทำการเปลี่ยนแปลงใด ๆ

วิธีการมีส่วนร่วม - แนวทาง

⚡มีส่วนร่วมใน Core Freeapi Codebase:

เรายินดีต้อนรับความสนใจของคุณในการมีส่วนร่วมในโครงการโอเพ่นซอร์สของเรา!

หากต้องการมีส่วนร่วมใน Freeapi โปรดทำตามขั้นตอนเหล่านี้:

1. แยกที่เก็บ
2. สร้างสาขาใหม่สำหรับคุณสมบัติหรือการแก้ไขข้อผิดพลาดของคุณ: git checkout -b feat/your-feature-name หรือ git checkout -b fix/your-bug-fix-name และทำการเปลี่ยนแปลง
3. เรียกใช้การทดสอบทั้งหมด? ก่อนที่จะทำการเปลี่ยนแปลงและตรวจสอบให้แน่ใจว่าผ่านการทดสอบทั้งหมด
4. หลังจากผ่านการทดสอบทั้งหมดแล้วให้ทำการเปลี่ยนแปลงของคุณด้วยข้อความเชิงพรรณนา: git commit -am 'add your commit message'
5. สำหรับรายละเอียดเพิ่มเติมเกี่ยวกับรูปแบบการกระทำและแนวทางอื่น ๆ โปรดดูแนวทางของผู้สนับสนุน
6. ผลักดันการเปลี่ยนแปลงของคุณไปยังที่เก็บข้อมูลของคุณ: git push origin feat/your-feature-name
7. ส่งคำขอดึงไปยังที่เก็บหลักอธิบายการเปลี่ยนแปลงที่คุณทำและให้รายละเอียดที่จำเป็นใด ๆ

นี่คือคำแนะนำเกี่ยวกับวิธีที่คุณสามารถมีส่วนร่วมใน Hub API ของเราได้อย่างมีประสิทธิภาพ:

1. ดึงคำขอสำหรับการอัปเดต readme: โปรดงดการส่งคำขอดึง แต่เพียงผู้เดียวสำหรับการอัปเดตไฟล์ readme ของโครงการ ในขณะที่เราชื่นชมความสำคัญของเอกสารที่ชัดเจนและรัดกุมเราต้องการมุ่งเน้นไปที่การมีส่วนร่วมของรหัสที่สำคัญและการปรับปรุงคุณสมบัติ

2. การอัปเดตไวยากรณ์: ทีมของเราให้ความสำคัญกับการสื่อสารที่มีประสิทธิภาพ แต่เราไม่ใช่ไวยากรณ์ Sticklers คุณไม่จำเป็นต้องส่งคำขอดึง แต่เพียงผู้เดียวสำหรับการแก้ไขไวยากรณ์หรือการปรับปรุงภาษาเล็กน้อย ให้จดจ่อกับฟังก์ชันหลักและคุณสมบัติของโครงการแทน

3. หลีกเลี่ยงการอัปเดต API สาธารณะที่มีอยู่: เพื่อรักษาเสถียรภาพและความมั่นคงเราไม่สนับสนุนการอัปเดตโดยตรงไปยัง API สาธารณะที่มีอยู่ภายในฮับ API API เหล่านี้ได้รับการทดสอบและอนุมัติอย่างละเอียด อย่างไรก็ตามหากคุณพบข้อบกพร่องหรือปัญหาใด ๆ เราขอแนะนำให้คุณเปิดปัญหาเกี่ยวกับตัวติดตามปัญหาของโครงการของเราเพื่อแจ้งให้เราทราบ

4. สร้าง APIs โครงการใหม่: เราขอแนะนำให้คุณสำรวจความคิดสร้างสรรค์ของคุณและมีส่วนร่วมโดยการสร้าง API โครงการที่สมบูรณ์ API เหล่านี้ควรจัดหาโซลูชั่นที่ครอบคลุมซึ่งสามารถช่วยนักพัฒนาในการสร้างโครงการที่ซับซ้อนเพื่อแสดงทักษะและความสามารถของพวกเขา การมีส่วนร่วมของคุณในพื้นที่นี้จะเป็นประโยชน์ต่อชุมชนอย่างมาก

5. ร่างข้อเสนอและหารือเกี่ยวกับความไม่ลงรอยกัน: ก่อนที่จะดำน้ำในโครงการของคุณเราขอแนะนำให้ร่างข้อเสนอ ซึ่งอาจรวมถึงแผนที่จิตใจหรือโครงร่างของ API ที่คุณตั้งใจจะสร้างและผลประโยชน์ที่อาจเกิดขึ้น เข้าร่วมชุมชน Discord ของเราซึ่งคุณสามารถแบ่งปันข้อเสนอของคุณหารือเกี่ยวกับแนวคิดและรวบรวมข้อเสนอแนะจากเพื่อนร่วมงาน การมีส่วนร่วมในการอภิปรายเหล่านี้จะช่วยเพิ่มพอร์ตแบ็กเอนด์ของคุณและช่วยกำหนดทิศทางในอนาคตของโครงการ

เราขอขอบคุณความกระตือรือร้นของคุณและหวังว่าจะมีส่วนร่วมอันมีค่าของคุณในโครงการ Open Source API Hub ของเรา

เราสามารถส่งเสริมสภาพแวดล้อมการทำงานร่วมกันและสร้างผลกระทบอย่างมีนัยสำคัญในภูมิทัศน์การรวม API

คลิกที่นี่เพื่อดูคู่มือการบริจาคโดยละเอียด

มีส่วนร่วมโดยการสร้างแอปพลิเคชันส่วนหน้า:

ขอขอบคุณสำหรับความสนใจในการมีส่วนร่วมในโครงการ Freeapi โดยการสร้างแอปพลิเคชันส่วนหน้าบริโภค Freeapis! ความพยายามของคุณมีบทบาทสำคัญในการเพิ่มประสบการณ์ผู้ใช้และขยายการเข้าถึง API ของเรา โปรดทำตามคำแนะนำนี้เพื่อให้แน่ใจว่ากระบวนการบริจาคที่ราบรื่นและทำงานร่วมกัน

คลิกที่นี่เพื่อดูคู่มือการบริจาคโดยละเอียดสำหรับนักพัฒนาส่วนหน้า!

- มีส่วนร่วมในชุดทดสอบ

ขอขอบคุณสำหรับความสนใจในการสนับสนุนโครงการ Freeapi เพื่อเพิ่มความครอบคลุมรหัสของบริการ API ของเราที่ช่วยให้เราจัดส่งจุดสิ้นสุดที่แข็งแกร่งซึ่งได้รับการทดสอบในสนามรบ โปรดทำตามคำแนะนำนี้เพื่อให้แน่ใจว่ากระบวนการบริจาคที่ราบรื่นและทำงานร่วมกัน

คลิกที่นี่เพื่อดูคู่มือการบริจาคโดยละเอียดสำหรับการเพิ่มความครอบคลุมของรหัส

เอกสาร Swagger

เอกสาร Swagger: https://api.freeapi.app

หมายเหตุ: เอกสาร Swagger ถูกสร้างขึ้นจากไฟล์ swagger.yaml ในขณะที่เรียกใช้โครงการในเครื่องตรวจสอบให้แน่ใจว่าคุณเปลี่ยน URL เป็น http://localhost:<port_from_.env>/api/v1 ในฟิลด์ Swagger docs servers/url