{"id":21356019,"url":"https://github.com/machi-projects/server-api-to-js-api","last_synced_at":"2025-06-24T10:34:09.759Z","repository":{"id":57170996,"uuid":"104619466","full_name":"machi-projects/server-api-to-js-api","owner":"machi-projects","description":"server api to js api cache mechanism","archived":false,"fork":false,"pushed_at":"2019-05-09T07:03:02.000Z","size":40,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-03-12T23:03:34.665Z","etag":null,"topics":["js-api","json"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/machi-projects.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-09-24T04:47:41.000Z","updated_at":"2019-05-09T07:03:03.000Z","dependencies_parsed_at":"2022-08-27T13:20:13.269Z","dependency_job_id":null,"html_url":"https://github.com/machi-projects/server-api-to-js-api","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/machi-projects%2Fserver-api-to-js-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/machi-projects%2Fserver-api-to-js-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/machi-projects%2Fserver-api-to-js-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/machi-projects%2Fserver-api-to-js-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/machi-projects","download_url":"https://codeload.github.com/machi-projects/server-api-to-js-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243830347,"owners_count":20354809,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["js-api","json"],"created_at":"2024-11-22T04:22:50.283Z","updated_at":"2025-03-16T05:25:58.359Z","avatar_url":"https://github.com/machi-projects.png","language":"JavaScript","readme":"#js-api-creator\n\n##How to install\n\n```\nnpm i js-api-creator\n```\n\n\n##How to use in your code - example\n\n```\nimport { constants } from 'js-api-creator'; \nlet jsonAPIS = {\n\t\"blogs\" : { url : \"connectBlogs\" , method : constants.get } ,\n\t\"blogs.create\" : { url : \"connectBlogs\" , method : constants.post } ,\n\t\"blogs.deleteIt\" : { url : \"connectBlogs/:id\" , method : constants.deleteIt } ,\n\t\"blogs.update\" : { url : \"connectBlogs/:id\" , method : constants.put }  ,\n\t\"blogs.get\" : { url : \"connectBlogs/:id\" , method : constants.get },\n\t\"blogs.getByPermalink\" : { url : \"connectBlogs/blogByPermalink\", method : constants.get } ,\n\t\"blogs.search\" : { url : \"connectBlogs/search\", method : constants.get },\n\t\"blogs.relatedBlogs\" : { url : \"connectBlogs/relatedArticleSearch\" , method : constants.get } ,\n\t\"blogs.like\" : { url : \"connectBlogs/:id/like\", method : constants.post },\n\t\"blogs.disLike\" : { url : \"connectBlogs/:id/dislike\", method : constants.post } ,\n\t\"blogs.attachments\" : { url : \"connectBlogs/:id/attachments\", method : constants.get } ,\n\t\"blogs.attachments.download\" : { url : \"connectBlogs/:blogId/attachments/:id/content\" ,\n\t\t\t\t\t\t\t\t\t method : constants.download }  ,\n\t\"blogs.updateFeedback\" : { url : \"connectBlogs/:id/feedbacks\", method : constants.post } ,\n\t\"blogs.comments\" : { url : \"connectBlogs/:id/comments\" , method : constants.get},\n\t\"blogs.comments.get\" :{ url : \"connectBlogs/:id/comments/:id\", method : constants.get },\n\t\"blogs.comments.attachments\" :{ url : \"connectBlogs/:blogId/comments/:id/attachments\", method : constants.get },\n\t\"blogs.comments.attachments.download\" : { url : \"connectBlogsBlogs/:blogId/comments/:commentId/attachments/:id/content\" , \n\t\t\t\t\t\t\t\t\t\tmethod : constants.download } ,\n\t\"categories\" : { url : \"connectCategory\" , method : constants.get }\n}\n\n```\n\n##How we are differenciating the multiple id's in url \u003c== from parameters\n\n```\n     Input : \n     \n    \"blogs.comments.attachments.download\" : { \n\t\turl : \"connectBlogsBlogs/:blogId/comments/:commentId/attachments/:id/content\" ,\n\t\tmethod : constants.download\n     }\n     \n     How we call : \n     blogs.comments.attachments.download({\n          blogId : 'efgh-abcd',                    ===\u003e refers blog id\n     \tcommentId : 'abcd-efgh',                 ===\u003e refers comment id\n     \tid : 'xyz-pqrs'                          ===\u003e refers attachment id\n     })\n\n    \n    What is the URL output : \n    \n    \t`connectBlogsBlogs/efgh-abcd/comments/abcd-efgh/attachments/xyz-pqrs/content`\n\n```\n\n\n##Exmaple build the apis\n\n```\nimport APIBuilder from 'js-api-creator'; \nlet apiBuilder = new APIBuilder( \n\t   (m)=\u003e\"https://myspace.com/space/v1/\" ,   ===\u003e prefix will be added for all urls + dynamic changable\n\t   (m)=\u003eglobalParameters,                   ===\u003e params will be added for all urls + dynamic changable\n\t   (m)=\u003eheaders                             ===\u003e header will be added for all urls + dynamic changable\n\t);\nlet apiModuleObject = apiBuilder.create( jsonAPIS, 'modueName' );\n\napiModuleObject.modueName.blogs( parameters , resolve , reject ) \napiModuleObject.modueName.blogs.Get( parameters , resolve , reject  ) \napiModuleObject.modueName.blogs.Search( parameters, resolve , reject )\napiModuleObject.modueName.categories( parameters, resolve , reject  )\n  \n```\n\n\n##method - Specific url prefix.\n\n```\nmodueName.blogs( { url } , parameters , resolve , reject )\n```\n\n\n\n##module - Specific url pattern prefix , global parameters and header.\n\n```\n\t new APIBuilder( \n\t \t(m)=\u003e{\n\t \t   if(m == \"kb\"){\n\t \t   \t return module-specific-prefix\n\t \t   }\n\t \t   \n\t \t   return prefix\n\t \t},\n\t \t\n\t \t(m)=\u003e{\n\t \t   if(m == \"kb\"){\n\t \t   \t return {module-specific-global-parameters}\n\t \t   }\n\t \t   \n\t \t   return {global-parameters}\n\t \t},\n\t \t\n\t \tif(m == \"kb\"){\n\t \t   \t return {module-specific-headers}\n\t \t   }\n\t \t   \n\t \t   return {global-headers}\n\t \t}\n\t );\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmachi-projects%2Fserver-api-to-js-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmachi-projects%2Fserver-api-to-js-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmachi-projects%2Fserver-api-to-js-api/lists"}