Skip to content

Commit

Permalink
add references/liara-api docs
Browse files Browse the repository at this point in the history
  • Loading branch information
A-Najmabadi committed Jul 30, 2024
1 parent 9b0b791 commit 0395604
Show file tree
Hide file tree
Showing 5 changed files with 259 additions and 15 deletions.
2 changes: 2 additions & 0 deletions src/components/Common/icons.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ import nuxtIcon from "@liara/platformicons/glass/png/nuxtjs.png";
import soketiIcon from "@liara/platformicons/glass/png/soketi.png";
import pythonIcon from "@liara/platformicons/glass/png/python.png";
import gatsbyIcon from "@liara/platformicons/glass/png/gatsby.png";
import jsonIcon from "@liara/platformicons/glass/png/json.png";

// Databases

Expand Down Expand Up @@ -107,6 +108,7 @@ const types = [
{ logo: laravelIcon, alt: "laravel" },
{ logo: netcoreIcon, alt: "netcore" },
{ logo: angularIcon, alt: "angularjs" },
{ logo: jsonIcon, alt: "json" },
// One-click-apps
{ logo: n8nIcon, alt: "n8n" },
{ logo: odooIcon, alt: "odoo" },
Expand Down
49 changes: 44 additions & 5 deletions src/components/Sidebar/data.js
Original file line number Diff line number Diff line change
Expand Up @@ -6569,11 +6569,11 @@ export default {
icon: <GoInfo />,
link: "/references/liara-cli/about"
},
{
title: "خلاصه دستورات",
icon: <GoInfo />,
link: "/references/liara-cli/about"
},
// {
// title: "خلاصه دستورات",
// icon: <GoInfo />,
// link: "/references/liara-cli/about"
// },
{
hr: true
},
Expand Down Expand Up @@ -6700,6 +6700,45 @@ export default {
link: "/references/liara-cli/choose-default-account"
},
],

'liara-api': [
{
badge: (
<div className="flex items-center gap-2">
<GoCode />
ابزار Liara API
</div>
)
},
{
title: "برگشت به خانه",
icon: <GoArrowRight />,
link: "/"
},
{
title: "Liara API چیست؟",
icon: <GoInfo />,
link: "/references/liara-api/about"
},
// {
// title: "خلاصه دستورات",
// icon: <GoInfo />,
// link: "/references/liara-api/about"
// },
{
hr: true
},
{
title: "مستندات OpenAPI",
icon: <IconContainer alt="json" />,
link: "https://openapi.liara.ir/"
},
{
title: "دریافت اطلاعات جامع کاربری",
icon: <GoInfo />,
link: "/references/liara-api/get-info"
},
],
},


Expand Down
90 changes: 90 additions & 0 deletions src/pages/references/liara-api/about.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
import Layout from "@/components/Layout";
import Button from "@/components/Common/button";
import Section from "@/components/Common/section";
import Alert from "@/components/Common/alert";
import Tabs from "@/components/Common/tab";
import Step from "@/components/Common/step";
import Card from "@/components/Common/card";
import Important from "@/components/Common/important";
import Highlight from "react-highlight";
import Link from "next/link";
import PlatformIcon from "@/components/Common/icons";

import {
GoContainer,
GoDatabase,
GoRocket,
GoServer,
GoMail,
GoGlobe,
GoArrowLeft,
} from "react-icons/go";

<Layout>
# Liara API
<hr className="mb-2" />

لیارا API مجموعه‌ای از توابع و پروتکل‌ها است که به کاربران اجازه می‌دهد تا از طریق درخواست‌های HTTP، منابع و سرویس‌های لیارا را مدیریت کنند. این API ها می‌توانند برای انجام وظایفی مانند ایجاد، حذف و مدیریت اپلیکیشن‌ها، دیتابیس‌ها و سایر منابع استفاده شوند. استفاده از لیارا API فرآیندهای مدیریت سرورها و اپلیکیشن‌ها را به صورت خودکار و ساده‌تر می‌کند.
<div className="h-2" />

هر کدام از محصولات لیارا، آدرس API مخصوص خود را دارند. برای مثال، آدرس API برای دسترسی به برنامه‌ها:

<div className="h-2" />
<div dir="ltr">
<Highlight className='bash'>
{`https://api.iran.liara.ir/`}
</Highlight>
</div>
<div className="h-2" />


<Section id="also-read" title="کلید دسترسی به API" />
کلید دسترسی به API یا API Key، یک رشته‌ی منحصربه‌فرد از کاراکترها است که به عنوان شناسه‌ی کاربر برای استفاده از API استفاده می‌شود. این کلید به منظور احراز هویت و تعیین سطح دسترسی کاربر به سرویس‌های مختلف API به کار می‌رود. با استفاده از کلید دسترسی، سرویس‌دهنده می‌تواند درخواست‌ها را به کاربر مشخصی نسبت دهد، مصرف منابع را مدیریت کند و امنیت را افزایش دهد. به‌عبارت‌دیگر، کلید دسترسی مانند یک گذرواژه عمل می‌کند که باید به‌صورت محرمانه نگهداری شود.

<div className="h-2" />
برای مشاهده کلید دسترسی به API حساب خود در لیارا، کافیست تا وارد منوی **API** شده و بر روی گزینه **ساخت کلید جدید**، کلیک کنید تا کلید API به شما، نمایش داده شود:

<div className="h-4" />
<img src="https://files.liara.ir/liara/docs/get-liara-api.gif" alt="get liara api" />
<div className="h-4" />
نحوه‌ی استفاده از این Token برای کار با APIها به این صورت است که آن را به‌شکل زیر در HEADERها به سمت endpoint مربوطه ارسال می‌کنید:

<div className="h-2" />
<div dir="ltr">
<Highlight className='bash'>
{`Authorization: Bearer $TOKEN`}
</Highlight>
</div>
<div className="h-2" />



<Section id="also-read" title="در ادامه، بخوانید:" />


<div className="grid grid-cols-2 gap-4">
{[
{
title: "مستندات OpenAPI",
link: "https://openapi.liara.ir/"
},
{
title: "دریافت اطلاعات جامع کاربری",
link: "/references/liara-api/get-info"
},].map(item =>
<Link href={item.link}>
<Card className="flex cursor-pointer w-full items-center justify-between">
<div className="flex items-center gap-3">
<h4>
{item.title}
</h4>
</div>
<GoArrowLeft className="ml-1" />
</Card>
</Link>
)}
</div>

<br />

</Layout>
37 changes: 37 additions & 0 deletions src/pages/references/liara-api/get-info.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
import Layout from "@/components/Layout";
import Button from "@/components/Common/button";
import Section from "@/components/Common/section";
import Alert from "@/components/Common/alert";
import Tabs from "@/components/Common/tab";
import Step from "@/components/Common/step";
import Card from "@/components/Common/card";
import Important from "@/components/Common/important";
import Highlight from "react-highlight";
import Link from "next/link";
import PlatformIcon from "@/components/Common/icons";

import {
GoContainer,
GoDatabase,
GoRocket,
GoServer,
GoMail,
GoGlobe,
GoArrowLeft,
} from "react-icons/go";

<Layout>
# دریافت اطلاعات جامع کاربری
<hr className="mb-2" />

در endpoint زیر شما می‌توانید به اطلاعات کاملی از حساب کاربری، پلن‌های قابل انتخاب به‌همراه قیمت، مشخصات هر پلن و نسخه‌های دیتابیس‌ها دسترسی داشته باشید. بنابراین از اطلاعاتی که از این endpoint دریافت می‌کنید می‌توانید در endpointهای دیگر استفاده کنید:

<div className="h-2" />
<div dir="ltr">
<Highlight className='bash'>
{`GET/v1/me`}
</Highlight>
</div>
<div className="h-2" />

</Layout>
96 changes: 86 additions & 10 deletions src/pages/references/liara-cli/about.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,22 +28,98 @@ import {

<Section id="also-read" title="در ادامه، بخوانید:" />

<div className="grid grid-cols-2 gap-4">
<div className="grid grid-cols-3 gap-4">
{[
{
text: 'آشنایی با جزئیات دیتابیس',
link: './details/about',
},
{
text: 'نحوه انتقال دیتابیس',
link: './move',
},
{
title: "نصب و به‌روزرسانی",
link: "/references/liara-cli/install"
},
{
title: "ورود به حساب کاربری",
link: "/references/liara-cli/login"
},
{
title: "مدیریت دیسک‌ها",
link: "/references/liara-cli/manage-disks"
},
{
title: "مشاهده پلن‌های سرویس پلتفرم",
link: "/references/liara-cli/see-platform-plans"
},
{
title: "تکمیل خودکار دستورات",
link: "/references/liara-cli/autocomplete"
},
{
title: "استقرار برنامه",
link: "/references/liara-cli/deploy-app"
},
{
title: "ایجاد یک برنامه",
link: "/references/liara-cli/create-app"
},
{
title: "حذف یک برنامه",
link: "/references/liara-cli/delete-app"
},
{
title: "لیست‌کردن برنامه‌ها",
link: "/references/liara-cli/list-apps"
},
{
title: "مشاهده لاگ‌های برنامه",
link: "/references/liara-cli/see-app-logs"
},
{
title: "ری‌استارت برنامه",
link: "/references/liara-cli/restart-app"
},
{
title: "اتصال به خط فرمان برنامه",
link: "/references/liara-cli/connect-to-app-shell"
},
{
title: "روشن‌کردن برنامه",
link: "/references/liara-cli/start-app"
},
{
title: "خاموش‌کردن برنامه",
link: "/references/liara-cli/stop-app"
},
{
title: " لیست متغیرهای ثبت شده برنامه",
link: "/references/liara-cli/list-envs"
},
{
title: "ثبت یا ویرایش متغیرهای محیطی",
link: "/references/liara-cli/add-or-edit-envs"
},
{
title: "حذف متغیرهای محیطی یک برنامه",
link: "/references/liara-cli/remove-env"
},
{
title: "اضافه کردن حساب کاربری جدید",
link: "/references/liara-cli/add-account"
},
{
title: "لیست حساب‌های کاربری ",
link: "/references/liara-cli/list-accounts"
},
{
title: "حذف یکی از حساب‌های کاربری",
link: "/references/liara-cli/remove-account"
},
{
title: "انتخاب حساب پیش‌فرض",
link: "/references/liara-cli/choose-default-account"
},
].map(item =>
<Link href={item.link}>
<Card className="flex cursor-pointer w-full items-center justify-between">
<div className="flex items-center gap-3">
<h4>
{item.text}
نحوه {item.title}
</h4>
</div>
<GoArrowLeft className="ml-1" />
Expand Down

0 comments on commit 0395604

Please sign in to comment.