\r\n\r\n- Request bodysi okumayan bir api gordunuz mu? Bir rest api, request bodysini, queryStringleri, vs parse edebilmek icin ekstra bir pakete ihtiyac duymamali. bir apiden bunu yapmasani bekleriz. Evet express bu kadar generic bir task icin bile 3.parti paketlere ihtiyac duyoyor. Ister netlify da deplay edin, ister node uzerinde Neptune her turlu request boundrysini parse edebilir.\r\n\r\n- Expressi serverless platformlarda deploy edemezsiniz. Buna karsin Neptune platform agnostictir.\r\n\r\n- yil 2022 Express halen promise desteklemiyor. Ister generator dondurun ister promise neptun hepsini kendi basina handle edebilir.\r\n- Neptune expressin (Model view controller router) yapisi yerine Resource,Service ve Provider kullanir.\r\n- Neptune XSRF, CSRF gibi bilindik tehtitler icin ekstra pakete ihtiyac duymaz, Zamanla guvenlik suitini gelistirmeye devam edecez.\r\n\r\n---\r\n\r\n- Neptunun tek eskisine gelecek olursak, NodeAdaptoru node 18~ e ihtiyac duyuyor\r\n\r\n# Neptuneun kullanimi\r\n\r\n## Neptune app\r\n\r\nBos bir neptune uygulamasi olusturmak bu kadar kolay\r\n\r\n```ts\r\nimport { createNeptune } from \"@.../neptune/app\";\r\n\r\nexport const app = createNeptune({\r\n adapter: NeptuneNodeAdapter,\r\n hostname: \"localhost\",\r\n port: 3000,\r\n resources: [],\r\n}).run();\r\n```\r\n\r\n## Neptune resource\r\n\r\nHer neptune resource uygulamamizin bir route'unu temsil ediyor\r\n\r\nBir users resource umuz var diyelim. /users e dusen her istek bu resource da karsilaniyor.\r\n\r\nResource basitce bir class NeptunResource abstract classini extend ediyor.\r\n\r\n```ts\r\n// userResource.ts\r\nimport { NeptunResource } from \"@.../common\";\r\n\r\nexport class UsersResource extends NeptuneResource {\r\n // bu bir array de olabilir [\"/users\" , \"/user\"]\r\n // bu durumda hem /users e hemde /user e atilan istek burada karsilanir\r\n public path = \"/users\";\r\n\r\n GET() {\r\n const users = [\"jdoe\", \"mdoe\", \"bdoe\"]; // dummy users\r\n return Response.json(users, 200, { \"Content-Type\": \"application/json\" });\r\n }\r\n}\r\n```\r\n\r\n```ts\r\nimport { NeptuneNodeAdapter } from \"@.../neptune/adapter\";\r\nimport { createNeptune } from \"@.../neptune/app\";\r\nimport { UserResource } from \"./path/to/userResource\";\r\nexport const app = createNeptune({\r\n adapter: NeptuneNodeAdapter,\r\n hostname: \"localhost\",\r\n port: 3000,\r\n resources: [UserResource],\r\n}).run();\r\n```\r\n\r\nGordugunuz gibi expressin her isi yapan bir routeri yerine bir isi cok iyi yapan bir resource ve her resource butun http methodlarini handle edebilir ( get, post, put, patch, delete, head, options, connect, trace). Bu sayede dahada moduler bir yapiya kavusmus oluyoruz.\r\n\r\n## Body parsing\r\n\r\nNeptune body parse edebilmek icin 3.parti paketlere ihtiyac durmaz. Her turlu boundaryi parse edebilir\r\n\r\n```ts\r\n//upload.ts\r\nimport { NeptunResource } from \"@.../common\";\r\nimport type { NeptuneFormData, NeptuneFile } from \"@.../internal\";\r\n\r\nexport class UploadResource extends NeptuneResource {\r\n public path = \"/user/upload\";\r\n\r\n // body parse etmek asenkron bir islem oldugundan async await kullanacam\r\n\r\n async POST(request: NeptuneRequest) {\r\n const data: NeptuneFormData = await request.formData();\r\n\r\n const profilePhoto: NeptuneFile = data.get(\"profile-photo\");\r\n //content type'i text/... haricinde olan hersey icin bize aslinda Reqdable stream olarak donuyor\r\n\r\n try {\r\n await createWriteStream(\"kaydedilecek/konum/resim.png\").pipe(\r\n profilePhoto\r\n );\r\n return Response.null(200);\r\n } catch {\r\n return Response.null(400);\r\n }\r\n }\r\n}\r\n```\r\n\r\nNeptuneRequest objesinin body parsing icin sahip oldugu methodlar Text(), Json(), Blob(), FormData(), Buffer(), Xml(), Query()\r\n\r\n## Sending Response Body\r\n\r\nNeptune kendi icinde her turlu datayi serialize edebilir\r\n\r\n```ts\r\nimport { NeptunResource } from \"@.../common\";\r\nimport { createReadStream } from \"fs\";\r\n\r\nclass DownloadResource extends NeptuneResource {\r\n public path = [\"/download\", \"icon.ico\"];\r\n\r\n async GET(request: NeptuneRequest) {\r\n if (request.path !== \"icon.ico\") {\r\n // Dosya stream olarak gonderildi.\r\n return createReadStream(\"gonderilecek/dosya.png\").pipe(\r\n Response.head({\r\n \"Content-Type\": \"img/png\",\r\n \"Content-Disposition\": 'attachment; inline; filename=\"filename.jpg\"',\r\n })\r\n );\r\n }\r\n\r\n // NeptuneResponse .File() methodunada sahip ancak bu buyuk dosyaladarda memory sorunlarina neden olabilir\r\n return await Response.File(\"icon.ico\", 200, {\r\n \"Content-Type\": \"img/png\",\r\n \"Content-Disposition\": 'attachment; inline; filename=\"filename.jpg\"',\r\n });\r\n }\r\n}\r\n```\r\n\r\n## Request parametresi almak\r\n\r\nneptune /foo/bar , /foo/:bar , /\\\\/foo\\\\/[a-z]+/, /foo/[a-z] seklindeki parametrelerin tumunu destekler\r\n\r\n```ts\r\nexport class UserResource extends NeptuneResource {\r\n public path = \"/user/:id\";\r\n\r\n GET() {\r\n const users = [\"jdoe\", \"mdoe\", \"bdoe\"]; // dummy users\r\n\r\n // this.param(\"id\") => \"1\"\r\n // this.params() => {id: \"1\"}\r\n return Response.Text(users[this.param(\"id\") as number]);\r\n }\r\n}\r\n```\r\n\r\n/user/1 e Get istegi atildigini varsayalim\r\n\r\naldigimiz cevap \"jdoe\" olacaktir\r\n\r\n## Error handling\r\n\r\nNeptune error handling icin cesitli imkanlar sunar. Bunlardan biri NeptuneError yardimci classi\r\n\r\n```ts\r\n//userNotFoundError.ts\r\nimport { NeptuneError } from from \"@.../common\";\r\n\r\nexport class UserNotFoundError extends NeptuneError {\r\n message = \"User not found\";\r\n status = 404\r\n}\r\n```\r\n\r\n```ts\r\nimport { NeptuneResource } from from \"@.../common\";\r\nimport type { INeptuneError } from from \"@.../common\";\r\nimport { UserNotFoundError } from \"../path/to/userNotFoundError\"\r\nexport class UserResource extends NeptuneResource {\r\n public path = \"/user/:id\";\r\n\r\n GET() {\r\n const users = [\"jdoe\", \"mdoe\", \"bdoe\"]; // dummy users\r\n\r\n\r\n if(!users[this.param(\"id\")]) throw new UserNotFoundError()\r\n\r\n return Response.Text(users[this.param(\"id\") as number]);\r\n }\r\n\r\n\r\n /*\r\n Resource icinde her hangi bir error firlatilirsa bu endpointe duser\r\n Burada gonderilecek responsa dair herseyi override edebilirsiniz\r\n Bu eger NeptuneError dan turetilmis bir class firlatildi ise bu endpoint zorunlu degildir ve tanimlanmadigi taktirde otomatik olarak Error sinifi donecektir\r\n {\r\n status: 404,\r\n body: {\r\n message: \"User not found\"\r\n }\r\n }\r\n\r\n */\r\n ERROR(error: INeptuneError ) {\r\n\r\n if(error instanceof UserNotFoundError) {\r\n return this.setHeader(\"x-user\", \"not found\")\r\n }\r\n\r\n else return Response.null(500)\r\n }\r\n}\r\n```\r\n\r\n/user/1 e istek atildigini varsayalim\r\n\r\ngelecek response su sekilde olacak\r\n\r\n```json\r\n{\r\n \"status\": 200,\r\n \"body\": \"mdoe\",\r\n \"headers\": {...}\r\n}\r\n```\r\n\r\neger /user/4 e istek atmis olsaydik\r\n\r\n```json\r\n{\r\n \"status\": 404,\r\n \"body\" : { \"message\" : \"User not found\"},\r\n \"headers\": {\r\n ...,\r\n \"x-user\": \"not found\"\r\n }\r\n}\r\n```\r\n\r\n## Gelecek veri tipini zorunlu tutma\r\n\r\nBunun icin NeptuneInput yardimci class indan turetilmis bir interface yada class kullanmak yeterli yeterli\r\n\r\n```ts\r\n import { NeptuneInput } from from \"@.../common\";\r\n // sadece typescript\r\n export interface ILoginInput extends NeptuneInput {\r\n password: string;\r\n username: string;\r\n }\r\n\r\n // yada\r\n\r\n export class LoginInput extends NeptuneInput {\r\n password: string;\r\n username: string;\r\n }\r\n```\r\n\r\n### Generic kullanmak **sadece Typescript**\r\n\r\n```ts\r\nimport { NeptuneResource } from from \"@.../common\";\r\nimport { ILoginInput } from \"../path/to/loginInput\";\r\nexport class LoginResource extends NeptuneResource {\r\n public path = \"/login\";\r\n\r\n async POST(request) {\r\n\r\n const { password, username } = await requset.json()\r\n // eger istenilen input gelirse sorunsuz bir sekilde ilerleyecek\r\n // gelmezse ise InputIsNotValid { error : InputNotValidError, message: \" InputNotValid\"} hatasi firlatilacak, ERROR handlerinda karsilayabilirsiniz\r\n\r\n\r\n return Response.Text(\"Wellcome user\");\r\n }\r\n\r\n}\r\n```\r\n\r\n### Declarative yontem\r\n\r\n```ts\r\nimport { NeptuneResource } from from \"@.../common\";\r\nimport { ILoginInput } from \"../path/to/loginInput\";\r\nexport class LoginResource extends NeptuneResource {\r\n public path = \"/login\";\r\n\r\n // POST methoduna gelen body inputa uygun olmazsa ayni process buradada isleyecek\r\n input = {\r\n POST: ILoginInput\r\n }\r\n\r\n async POST(request) {\r\n\r\n const { password, username } = await requset.json()\r\n\r\n\r\n\r\n return Response.Text(\"Wellcome user\");\r\n }\r\n\r\n}\r\n```\r\n\r\n# Servisler\r\n\r\nServisleri Express middleware leri gibi dusune bilirsiniz. Ancak dahada fazlasi var\r\n\r\nServislerde basitce bir class NeptuneService abstract classindan turetiliyor\r\n\r\n```ts\r\n\r\n//authService.ts\r\nimport { NeptuneService } from from \"@.../common\";\r\n\r\n\r\nclass AuthService extends NeptuneService {\r\n\r\n runBeforeResource(request) {\r\n\r\n const token = this.cookies(\"token\")\r\n\r\n if(!token) throw new IsNotAuthError() // dummy authError classi\r\n\r\n const verify = jwt.verify(token) // dummy jwt :D\r\n\r\n if(!token) throw new TokenIsNotValidError() // dummy tokenNotValidError classi\r\n\r\n\r\n // Keyleri string tipinde olan her hangi bir obje donebilirsiniz buna daha sonra gelecez\r\n return {\r\n session: verify\r\n }\r\n }\r\n\r\n\r\n // eger ERROR methodu service icinde tanimlandiysa mutlaka response donmelidir.\r\n // tanimlanmadi ise Resource daki error methodu calisacaktir. eger o da yoksada error classina gore response donecektir\r\n ERROR (error) {\r\n Response.null(401)\r\n }\r\n}\r\n```\r\n\r\nSoyle bir seneryomuz olsun, kullanici addressini degistirmek istiyor diyelim. Bu resourca gelmeden once giris yapip yapmadigini kontrol ediyoruz. Eger giris yapti ise buradaki pathc methodu calissin yoksa 401 gonderip istegi sonlandirsin\r\n\r\n```ts\r\n//...imports\r\n\r\nexport class AddressResource extends NeptuneResource {\r\n public path = \"/user/address\";\r\n\r\n // bu resourca HER PATHC istegi geldiginde pathc dizinindeki her servis sirasi ile calisacak\r\n services: {\r\n PATHC: [AuthService] // service ler bir biri ardina chain edilebilir\r\n }\r\n\r\n async PATCH(request) {\r\n\r\n const address = await requset.json()\r\n\r\n // servislerin dondugu her objeye this.locals den ulasabiliriz. servislerin dondugu her locals objesi bir birine merge edilir. ayrica locals objesi servislerde de ulasilabilirdir. bir servisin dondugu locals objesine diger servisten ulasilabilir\r\n const user = this.locals.session; // Service den tanidik geldi mi?\r\n\r\n // providerlera servislerden sonra gelecez\r\n const newAddress = await (this.providers.getProvider(\"UserProvider\")).getUser(user).setAddress(address)\r\n\r\n return Response.json(newAddress)\r\n }\r\n\r\n}\r\n```\r\n\r\n# Providers\r\n\r\nProvider lari viewModel gibi dusunebilirsiniz.\r\nProviderlar NeptuneProvider abstract classindan turetiliyor. Providerlar Transient, singleton ve scoped olarak calisabilirler ve Neptune de di containerlarinin temelini olusturur\r\n\r\n```ts\r\n// userProvider.ts\r\nimport { NeptuneProvider } from \"@.../ioc\";\r\n\r\nexport class UserProvider extends NeptuneProvider {\r\n scope = \"transient\"; // \"transient\" , \"singleton\" , \"scoped\"\r\n name = \"UserProvider\"; // providerlara ulasmak icin gerekli\r\n findUserById(id) {\r\n // fake UserModel\r\n return UserModel.findById(id);\r\n }\r\n}\r\n```\r\n\r\n```ts\r\n//...imports\r\n\r\nexport const app = createNeptune({\r\n adapter: NeptuneNodeAdapter,\r\n hostname: \"localhost\",\r\n port: 3000,\r\n resources: [UserResource],\r\n providers: [UserProvider], // providerimizi ekledik\r\n}).run();\r\n```\r\n\r\nproviderlara herhangi bir resource, service veya baska bir providerdan erisilebilir\r\n\r\n```ts\r\n//...imports\r\n\r\nexport class UserResource extends NeptuneResource {\r\n public path = \"/user/:id\";\r\n\r\n async GET(request) {\r\n // providerlera servislerden sonra gelecez\r\n // Providerlara ulasmak asenkrondur, sadece cagirildiklarinda inject edilir ve sonrasinda dispose edilir\r\n const userProvider = await this.providers.getProvider(\"UserProvider\");\r\n\r\n return Response.json>(\r\n userProvider.findUserById(this.param(\"id\"))\r\n );\r\n }\r\n}\r\n```\r\n","readmeFilename":"readme.md","description":"Basitce Neptune object-driven rest api frameworku dur."}
![\"evrendeki](\"https://substackcdn.com/image/fetch/w_1456,c_limit,f_auto,q_auto:good,fl_progressive:steep/https%3A%2F%2Fbucketeer-e05bbc84-baa3-437e-9518-adb32be77984.s3.amazonaws.com%2Fpublic%2Fimages%2Fcf8075dc-9d40-4d54-8762-b8643a4be8a8_1193x790.png\")
\r\n \r\n