https://github.com/icreated/swagger
Idempiere Swagger Plugin (for WebStore API & not only)
https://github.com/icreated/swagger
idempiere openapi swagger
Last synced: 2 months ago
JSON representation
Idempiere Swagger Plugin (for WebStore API & not only)
- Host: GitHub
- URL: https://github.com/icreated/swagger
- Owner: icreated
- Created: 2019-11-05T13:37:03.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2025-03-18T21:15:31.000Z (over 1 year ago)
- Last Synced: 2025-03-18T22:24:20.392Z (over 1 year ago)
- Topics: idempiere, openapi, swagger
- Language: HTML
- Homepage: https://icreated.co/projects/swagger
- Size: 8.62 MB
- Stars: 1
- Watchers: 2
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ∫ created
> Integration created
# Idempiere OpenAPI
>
This is simple OpenApi implementation (version 3.22.2) for Idempiere OSGI platform.
This OpenApi application was created to work together with Idempiere WebStore / Portal API
[https://github.com/icreated/webstore-api](https://github.com/icreated/webstore-api)
[https://github.com/icreated/portal-api](https://github.com/icreated/portal-api)
It should point to following **openapi.xml** for WebStore:
[http://localhost:8080/services/openapi.yaml](http://localhost:8080/services/openapi.yaml)
or
[http://localhost:8080/portal/openapi.yaml](http://localhost:8080/portal/openapi.yaml)
for Portal API
## Installing / Getting started
To build this plugin you need to get sources in your project directory:
```shell
git clone https://github.com/icreated/webstore-api.git
```
If used with others API plugins, modify path in pom.xml:
```yml
http://localhost:8080/services/openapi.yaml
```
Build it with Maven:
```shell
mvn install
```
Deploy plugin to Idempiere OSGI and navigate to OpenAPI URL:
[http://localhost:8080/openapi/app/](http://localhost:8080/openapi/app/)
## Contributing
If you'd like to contribute, please fork the repository and use a feature
branch.
Pull requests are warmly welcome
## Licensing
GNU General Public License