express-api-pack-tr v0.1.4
Express için tasarlanmış api araçları paketine hoş geldiniz
Bu içerikte bu paketin kullanımı hakkında detaylı bilgi sunmaya çalışacağız. Okumaya başlamadan önce bir kaç bilgilendirmede bulunmak isteriz. Bu kullanmakta olduğunuz yada kullanmaya başlayacağınız paket tümüyle ücretsiz ve açık kaynaklıdır. Hem TypeScript hem de JavaScript ile kullanmak mümkündür.
Özellikler
- Kolay bir şekilde api için gerekli değerleri kontrol etme
- İstek limitleyici ve captcha kullanımını kolaylaştırma
- Kolay bir şekilde api için gerekli e-postaları göndermeyi mümkün kılma
- Auth işlemlerini basitleştirme ve güvenli kılma
Kurulum
Bu paketin kurulumu ve kullanmaya başlaması oldukça kolaydır. Windows, Linux yada Mac için kurulum süreçleri aynıdır ve her sistem için uyumludur.
npm i express-api-pack-tr
Projeye dahil etme
Projeye dahil edilmesi istenen her middleware'ların yada controller'ların gerekli olanların isimleri ile birlikte ayrı ayrı olarak eklenmesi gereklidir.
Hepsini tek seferde projeye dahil etmek istiyorsanız,
TypeScript için:
import * as packs from 'express-api-pack';
let auth = packs.auth;
let create_id = packs.create_id;
JavaScript için:
const packs = require('express-api-pack');
let auth = packs.auth;
let create_id = packs.create_id;
şeklinde tek bir değişkene atayarak hepsini ekleyebilirsiniz.
Paketlerin detaylı kullanımı
Paketlerin bazı genel özellikleri
Paketlerde req ve res objesinden bir değeri middleware ve controllerlıra göndermek için aşağıdaki örnekte gösterilen yolu izlemelisiniz.
app.post('/',
check_required_values([{
location:'req.body.username',
type:'string'
}]),
(req,res) => {
res.send('Hello')
}
)
Yukarıdaki check_required_values middlewareında gösterlidiği gibi objeden bir değeri seçmek için '' yada "" içerisinde obejenin konumu belirtmelidir.
Detaylı dökümanlar
Detaylı kullanımlarını öğrenmek istediğiniz middleware yada controllara ait bağlantıya tıklayarak okuyabilirsiniz.
Middlewarelar
- auth
- captcha
- check_get-database-value
- check-email
- check-required-values
- count-visits
- crate-jwt
- create-id
- delete-cookie
- emailer
- get-config
- hasher
- req-limit
- save-cookie
- save-database-values
- searcher
Controllerlar
Utils
Destek
Destek için lim10tech@gmail.com adresinden bana erişebilirsiniz. En yakın sürede cevaplarım.
Lisans
Bu kullanmakta olduğunuz yada kullanmaya başlayacağınız paket tümüyle ücretsiz ve açık kaynaklıdır.