{"id":26615928,"url":"https://github.com/serban-petrescu/sapim","last_synced_at":"2025-04-10T05:36:13.785Z","repository":{"id":79819688,"uuid":"118663004","full_name":"serban-petrescu/sapim","owner":"serban-petrescu","description":"SAP API Manager Tools","archived":false,"fork":false,"pushed_at":"2020-02-24T08:31:20.000Z","size":495,"stargazers_count":6,"open_issues_count":2,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-01T02:03:31.650Z","etag":null,"topics":["api-management","cli","nodejs","sap"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/serban-petrescu.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-01-23T20:07:14.000Z","updated_at":"2021-10-13T17:19:46.000Z","dependencies_parsed_at":"2023-03-29T05:17:30.408Z","dependency_job_id":null,"html_url":"https://github.com/serban-petrescu/sapim","commit_stats":{"total_commits":17,"total_committers":1,"mean_commits":17.0,"dds":0.0,"last_synced_commit":"f2fd645c517aca8f78a8e500c9360b9b659f8e42"},"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/serban-petrescu%2Fsapim","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/serban-petrescu%2Fsapim/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/serban-petrescu%2Fsapim/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/serban-petrescu%2Fsapim/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/serban-petrescu","download_url":"https://codeload.github.com/serban-petrescu/sapim/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248164300,"owners_count":21058119,"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":["api-management","cli","nodejs","sap"],"created_at":"2025-03-24T06:46:11.245Z","updated_at":"2025-04-10T05:36:13.759Z","avatar_url":"https://github.com/serban-petrescu.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# sapim\n\u003e SAP API Manager Tools\n\nA suite of tools for deploying and building SAP API Manager API proxies and key-value maps. Check out the [wiki](https://github.com/serban-petrescu/sapim/wiki) for more information.\n\n## Install\n### Via npm\n\n```sh\n# If you just want to use the command line interface:\nnpm install sapim -g\n\n# If you want to use the package during development or build-time:\nnpm install sapim --save-dev\n\n# If you want to use the API during runtime:\nnpm install sapim --save\n```\n### Binary download\nFor using the library purely as a command line tool, a binary version (for x64 OS) can be downloaded from the [releases](https://github.com/serban-petrescu/sapim/releases) section. This binary exexcutable does not depend on the presence of NodeJS or NPM on your system.\n\n## Usage\n### Manifests\nThe package uses YAML or JSON-based manifests for describing the API Manager artifacts. These manifest must adhere to the schema described by `manifest.schema.json`.\n\n```yml\nproxy:\n  name: my-test-proxy\n  path: ./my-test-proxy\n  templated: true\n  placeholders:\n    some-placeholder-name: My string value here\n    another-placeholder: Another string value here\nmaps:\n  my-first-map-name:\n    some-string-key: Some string value\n```\n### Command-line interface\nTo use the commands that imply communicating with the API Manager, you need to provide a user, password and host for the library to use. You have two options for specifying them:\n\n - Using the environment variables `SAPIM_USERNAME`, `SAPIM_PASSWORD` and `SAPIM_HOST`.\n - Using a [.env](https://github.com/motdotla/dotenv) file for loading the environment variables mentioned above.\n - Using a [.sapim](https://github.com/serban-petrescu/sapim/wiki/Configuration#using-a-sapim-file) file.\n\nFor more details, check out the [configuration](https://github.com/serban-petrescu/sapim/wiki/Configuration) wiki page.\n\nThe following commands are available:\n - build commands\n   - [package manifest](https://github.com/serban-petrescu/sapim/wiki/Command-Line-Interface#package)\n   - [package all](https://github.com/serban-petrescu/sapim/wiki/Command-Line-Interface#package-all-manifests)\n   - [package proxy](https://github.com/serban-petrescu/sapim/wiki/Command-Line-Interface#package-proxy)\n - deployment commands\n   - [deploy manifest](https://github.com/serban-petrescu/sapim/wiki/Command-Line-Interface#deploy-manifest)\n   - [deploy all](https://github.com/serban-petrescu/sapim/wiki/Command-Line-Interface#deploy-all-manifests)\n   - [deploy proxy](https://github.com/serban-petrescu/sapim/wiki/Command-Line-Interface#deploy-proxy)\n - template commands\n   - [apply template](https://github.com/serban-petrescu/sapim/wiki/Command-Line-Interface#apply-template)\n   - [extract template (manifest)](https://github.com/serban-petrescu/sapim/wiki/Command-Line-Interface#extract-template-from-manifest)\n   - [extract template (proxy)](https://github.com/serban-petrescu/sapim/wiki/Command-Line-Interface#extract-template-from-files)\n - misc commands\n   - [upload proxy](https://github.com/serban-petrescu/sapim/wiki/Command-Line-Interface#upload-proxy)\n   - [download proxy](https://github.com/serban-petrescu/sapim/wiki/Command-Line-Interface#download-proxy)\n   - [configure](https://github.com/serban-petrescu/sapim/wiki/Command-Line-Interface#configure)\n   - [get proxy url](https://github.com/serban-petrescu/sapim/wiki/Command-Line-Interface#get-proxy-url)\n   - [get manifest url](https://github.com/serban-petrescu/sapim/wiki/Command-Line-Interface#get-manifest-url)\n   - [get virtual host info](https://github.com/serban-petrescu/sapim/wiki/Command-Line-Interface#get-virtual-host-info)\n\n### Programmatic usage\nAll the above commands have a corresponding method exposed as part of the library's public API. You can read more about using it [in the corresponding wiki page](https://github.com/serban-petrescu/sapim/wiki/Programmatic-Usage) and you can find the reference documentation [on GitHub Pages](https://serban-petrescu.github.io/sapim/sapim/0.0.7/).\n\nExample usage:\n```js\n    var sapim = require(\"sapim\").default();\n    sapim.deployManifest(\"/path/to/my/manifest.yaml\")\n      .then(function() {\n         console.log(\"Success!\");\n      });\n```\n## License\nSAP API Management Tools under copyright (c) 2018-present Serban Petrescu \u003cSerban.Petrescu@outlook.com\u003e\n\nThis library is free software, licensed under the Apache License, Version 2.0. See the file `LICENSE` in this distribution for more details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fserban-petrescu%2Fsapim","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fserban-petrescu%2Fsapim","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fserban-petrescu%2Fsapim/lists"}