مهم
عرض وثائق بيتا V1 - قابلة للاستخدام ولكن نتوقع تغيير التغييرات. للحصول على نسخة مستقرة ، انظر هنا
يا! باستخدام React ، Vue أو Astro؟ تحقق من مشروع أخطاء المشروع الجديد لكتابة رمز أقل بنسبة 50 ٪.
npm install json-server
إنشاء ملف db.json
أو db.json5
{
"posts" : [
{ "id" : " 1 " , "title" : " a title " , "views" : 100 },
{ "id" : " 2 " , "title" : " another title " , "views" : 200 }
],
"comments" : [
{ "id" : " 1 " , "text" : " a comment about post 1 " , "postId" : " 1 " },
{ "id" : " 2 " , "text" : " another comment about post 1 " , "postId" : " 1 " }
],
"profile" : {
"name" : " typicode "
}
}
{
posts : [
{ id : '1' , title : 'a title' , views : 100 } ,
{ id : '2' , title : 'another title' , views : 200 } ,
] ,
comments : [
{ id : '1' , text : 'a comment about post 1' , postId : '1' } ,
{ id : '2' , text : 'another comment about post 1' , postId : '1' } ,
] ,
profile : {
name : 'typicode' ,
} ,
}
يمكنك قراءة المزيد حول تنسيق JSON5 هنا.
مررها إلى JSON Server CLI
$ npx json-server db.json
احصل على API REST
$ curl http://localhost:3000/posts/1
{
" id " : " 1 " ,
" title " : " a title " ,
" views " : 100
}
قم بتشغيل json-server --help
للحصول على قائمة بالخيارات
الرعاة |
---|
الرعاة |
---|
الرعاة | |
---|---|
كن راعياً واحصل على شعار شركتك هنا
ملحوظة
يستخدم هذا المشروع ترخيص المصدر العادل. يُطلب من المؤسسات التي تضم 3+ مستخدمين فقط المساهمة بمبلغ صغير من خلال راعي الرعاية للاستخدام. يساعد هذا الترخيص في الحفاظ على المشروع مستدامًا وصحيًا ، ويفيد الجميع.
لمزيد من المعلومات ، والأسئلة الشائعة ، والأساس المنطقي وراء ذلك ، تفضل بزيارة https://fair.io/.
استنادًا إلى مثال db.json
، ستحصل على الطرق التالية:
GET /posts
GET /posts/:id
POST /posts
PUT /posts/:id
PATCH /posts/:id
DELETE /posts/:id
# Same for comments
GET /profile
PUT /profile
PATCH /profile
→ ==
lt
→ <
lte
→ <=
gt
→ >
gte
→ >=
ne
→ !=
GET /posts?views_gt=9000
start
end
limit
GET /posts?_start=10&_end=20
GET /posts?_start=10&_limit=10
page
per_page
(افتراضي = 10) GET /posts?_page=1&_per_page=25
_sort=f1,f2
GET /posts?_sort=id,-views
xyz..
xyz[i]...
GET /foo?a.b=bar
GET /foo?x.y_lt=100
GET /foo?arr[0]=bar
GET /posts?_embed=comments
GET /comments?_embed=post
DELETE /posts/1
DELETE /posts/1?_dependent=comments
إذا قمت بإنشاء دليل ./public
يمكنك أيضًا إضافة أدلة مخصصة باستخدام خيار -s/--static
.
json-server -s ./static
json-server -s ./static -s ./node_modules
id
دائمًا عبارة عن سلسلة وسيتم إنشاؤها لك إذا فقدت_per_page
مع _page
بدلاً من _limit
للترقيمNetwork tab > throtling
لتأخير الطلبات بدلاً من --delay
CLI