slamby api

slamby api

Slamby แนะนำ Slamby Server (API) สร้างบริการการจัดการข้อมูลที่มีประสิทธิภาพจัดเก็บและวิเคราะห์ข้อมูลของคุณ

เอกสารผลิตภัณฑ์

ตรวจสอบเอกสาร API ของเรา

การติดตั้งด้วย Docker

Slamby API สามารถค้นหาได้บนศูนย์กลาง Docker

ด้วย Docker Compose (แนะนำ)

เนื่องจาก Slamby API มีการพึ่งพา: Elasticsearch, Redis และ Nginx (แนะนำ) วิธีที่ง่ายที่สุดในการใช้ Slamby API คือกับนักเทียบท่า

เราจัดทำไฟล์แต่งเพลงที่เตรียมไว้สำหรับการติดตั้งที่ง่าย

ขั้นตอน

1. ติดตั้ง Docker บนเครื่องของคุณ: คู่มือการติดตั้ง Docker อย่างเป็นทางการ

2. ติดตั้ง Docker Compose บนเครื่องของคุณ (ต้องการขั้นต่ำ 1.9.0): คู่มือการติดตั้ง Docker Compose อย่างเป็นทางการ

3. ดาวน์โหลดไฟล์ Compose Docker ของเรา

 $ curl -L "https://github.com/slamby/slamby-api/releases/download/v1.7.2/docker-compose.yml" > docker-compose.yml

4. เขียนคอนเทนเนอร์ (เรียกใช้ถัดจากไฟล์ PISCOSE)

 $ docker-compose -p slamby up -d

5. เซิร์ฟเวอร์ของคุณติดตั้ง ตรวจสอบว่าใช้งานได้อย่างถูกต้อง

 $ curl localhost

{
  "Name": "Slamby.API",
  "Version": "1.7.2",
  "InstanceId": "817021ac-cc23-4473-b203-5083c3e7e00e",
  "Information": "https://developers.slamby.com"
}

6. เปิดหน้าการตั้งค่าในเบราว์เซอร์ (http: // localhost/setup) และทำตามคำสั่งซื้อ

   ในระหว่างการตั้งค่าคุณต้อง:

   • ขอใบอนุญาต Slamby
   • คัดลอกใบอนุญาต Slamby API ของคุณ
   • ตั้งค่าความลับ (รหัสผ่าน) สำหรับ Slamby API ของคุณ

กับ Docker (ขั้นสูง)

คุณสามารถใช้เซิร์ฟเวอร์ Slamby API โดยไม่ต้องเขียน แต่ Slamby API มีข้อกำหนดเบื้องต้น คุณต้องให้การตั้งค่ากับเซิร์ฟเวอร์ Slamby API ผ่านตัวแปรสภาพแวดล้อม (สิ่งเหล่านี้เป็นเช่น: SlambyApi__... ) โปรดทราบว่าหากคุณเรียกใช้ในคอนเทนเนอร์คุณต้องตั้งค่าตัวแปรสภาพแวดล้อมให้เป็นคอนเทนเนอร์ที่ไม่ใช่โฮสต์ หากคุณใช้ระบบปฏิบัติการที่คุณสามารถใช้ : ในชื่อตัวแปรสภาพแวดล้อมมากกว่าที่คุณต้องใช้ : แทนที่จะเป็น __

ข้อกำหนดเบื้องต้น

Elasticsearch

Slamby API ใช้ Elasticsearch เป็นระบบจัดเก็บข้อมูล คุณสามารถใช้อินสแตนซ์หรือคลัสเตอร์ของตัวเอง เวอร์ชันที่แนะนำคือ 2.3 จะต้องว่างเปล่า (ไม่มีดัชนี) และขอแนะนำให้ติดตั้งปลั๊กอิน Mapper-Attachments ตั้งค่า URL Elasticsearch เป็น SlambyApi__ElasticSearch__Uris__0 (เช่น: http: // ElasticsearchServer: 9200/) หรือถ้าคุณมีคลัสเตอร์ที่มีจุดสิ้นสุดหลายจุดตั้งค่าจุดสิ้นสุดทั้งหมดเป็น SlambyApi__ElasticSearch__Uris__0 , SlambyApi__ElasticSearch__Uris__1 , SlambyApi__ElasticSearch__Uris__2 ฯลฯ ตัวแปรสภาพแวดล้อม)

Redis

Slamby API โดยใช้ REDIS สำหรับการทำดัชนีล่วงหน้าและเพื่อบันทึกตัวชี้วัดบางอย่าง ตั้งค่าสตริงการเชื่อมต่อ Redis ใน SlambyApi__Redis__Configuration
คุณสามารถปิดการใช้งานการใช้ Redis ได้หากคุณต้องการตั้งค่า Set SlambyApi__Redis__Enabled ใช้งานเป็น false (โปรดทราบว่าในกรณีนี้คุณไม่สามารถใช้คุณสมบัติบางอย่างเช่น PRC prefeRindexing)

nginx

Slamby API โดยใช้ Dotnet Core และ Kestrel ภายใต้ประทุน ขอแนะนำให้ใช้ nginx ที่ด้านบนของมัน เรามีภาพ Nginx ที่กำหนดค่าไว้ล่วงหน้าใน DockerHub ขอแนะนำให้ใช้สิ่งนี้ แต่คุณสามารถใช้เซิร์ฟเวอร์ Nginx ของคุณเอง

ไดเรกทอรี Slamby

สร้างไดเรกทอรีบนคอมพิวเตอร์โฮสต์สำหรับไฟล์ Slamby API แบบถาวร

การติดตั้ง

ดึงภาพจาก Docker Hub

 docker pull slamby/slamby.api:1.7.2

เรียกใช้คอนเทนเนอร์ด้วยการตั้งค่า

 docker run -d 
  --name slamby_api 
  -p 5000:5000 
  -v /yourDataDirectory:/Slamby 
  slamby/slamby.api:1.7.2

Slamby API ใช้พอร์ต 5000 โดยค่าเริ่มต้น แต่คุณสามารถผูกกับพอร์ตใดก็ได้ที่คุณต้องการบนโฮสต์ Docker ของคุณ

การตั้งค่า

คุณสามารถแทนที่การตั้งค่าโดยตัวแปรสภาพแวดล้อม โปรดทราบว่าหากคุณใช้ระบบปฏิบัติการที่คุณสามารถใช้งานได้ : ในชื่อตัวแปรสภาพแวดล้อมมากกว่าที่คุณต้องใช้ : แทนที่จะเป็น __

นี่คือรายการการตั้งค่าที่สำคัญที่สุด คุณสามารถค้นหาการตั้งค่าทั้งหมดในไฟล์ appsettings.json

SlambyApi__ApiSecret

ค่าเริ่มต้น: s3cr3t

นี่คือความลับสำหรับ API ของคุณ คุณต้องใช้สิ่งนี้เพื่อตรวจสอบคำขอของคุณ

SlambyApi__BaseUrlPrefix

มันว่างเปล่าตามค่าเริ่มต้น

หากคุณใช้ API ที่อยู่เบื้องหลังพร็อกซีย้อนกลับมากกว่าที่คุณต้องใช้ค่านี้ เพราะในกรณีนี้ชื่อโฮสต์จะไม่ถูกต้อง API จะวางโฮสต์ HTTP ของคำขอหลังจากนั้น

ElasticSearch__Uris__NUMBER

โปรดทราบว่านี่คือค่าการกำหนดค่าอาร์เรย์ ดังนั้นคุณต้องใส่ 0, 1, 2 ... แทนที่จะเป็นหมายเลข

มีค่าเริ่มต้น ElasticSearch__Uris__0 ที่มีค่าเริ่มต้น: 'http://elasticsearch:9200/'

SlambyApi__Serilog__Output

ค่าเริ่มต้น: /Slamby/Logs

ไดเรกทอรีเอาต์พุตของไฟล์บันทึก

SlambyApi__Serilog__MinimumLevel

ค่าเริ่มต้น: Information

ระดับบันทึกขั้นต่ำ

SlambyApi__Redis__Configuration

ค่าเริ่มต้น: redis,abortConnect=false,ssl=false,syncTimeout=30000

สตริงการเชื่อมต่อสำหรับเซิร์ฟเวอร์ Redis

SlambyApi__Parallel__ConcurrentTasksLimit

ค่าเริ่มต้น: 0

ขีด จำกัด สูงสุดของเธรดที่ใช้ในการดำเนินการแต่ละครั้ง ถ้าเป็น 0 ดังนั้น API ที่ใช้ หมายเลขหลัก * 2 เพื่อประสิทธิภาพที่ดีที่สุด เคล็ดลับ: คุณสามารถ จำกัด ได้ในแต่ละส่วนหัวคำขอด้วย ตรวจสอบในเอกสาร API

SlambyApi__RequestsLimiting__MaxConcurrentRequests

ค่าเริ่มต้น: 50

ด้วยการตั้งค่านี้คุณสามารถตั้งค่าหมายเลขคำขอพร้อมกันสูงสุด หากมีคำขอพร้อมกันมากกว่าหมายเลขนี้ API จะตอบสนองด้วยรหัสสถานะ HTTP 503 (ไม่พร้อมใช้งานบริการ)

ปัญหา

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

การบริจาค

โปรดตรวจสอบคู่มือการบริจาคของเราที่นี่

ใบอนุญาต

โครงการนี้ได้รับใบอนุญาตภายใต้ใบอนุญาตสาธารณะ GNU Affero ทั่วไปเวอร์ชัน 3.0

สำหรับการใช้งานเชิงพาณิชย์โปรดติดต่อเราที่ [email protected] และซื้อใบอนุญาตเชิงพาณิชย์

ติดต่อ

หากคุณมีคำถามใด ๆ กรุณาเยี่ยมชมกลุ่มชุมชนของเราหรือเขียนอีเมลถึงเราที่ [email protected]