https://github.com/lfdt-web3j/web3j-openapi
OpenAPI compliant service generator for Solidity Smart contracts
https://github.com/lfdt-web3j/web3j-openapi
ethereum openapi solidity swagger web3j
Last synced: 7 months ago
JSON representation
OpenAPI compliant service generator for Solidity Smart contracts
- Host: GitHub
- URL: https://github.com/lfdt-web3j/web3j-openapi
- Owner: LFDT-web3j
- Created: 2020-03-31T09:12:05.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2025-03-07T17:13:47.000Z (11 months ago)
- Last Synced: 2025-04-04T21:23:35.129Z (10 months ago)
- Topics: ethereum, openapi, solidity, swagger, web3j
- Language: Solidity
- Homepage: https://www.web3labs.com/epirus
- Size: 1.32 MB
- Stars: 37
- Watchers: 8
- Forks: 11
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
Web3j Open API
==============
[](https://travis-ci.org/web3j/web3j-openapi)
Web3j-OpenAPI is a [OpenAPI](https://swagger.io/specification/) client and server generator from
[Solidity](https://solidity.readthedocs.io/) smart contracts. it provides a way to interact with the Ethereum blockchain via simple and intuitive
HTTP requests, abstracting the coding layer. These interactions can be done using :
- Plain HTTP requests
- Via the `Swagger-UI`, which is generated with every project
- A client application using the [`webj3-openapi-client`](/client) implementation
The workflow can be summed in the following steps:
- Writing a Solidity smart contract
- Generating the corresponding **OpenAPI** project using **Web3j-OpenAPI**
- Running the generated project as a standalone server
- Sending HTTP requests using `Swagger-UI`, client application or `Curl` request.
# Getting started with Web3j-OpenAPI
To generate an OpenAPI project using the [Web3j-OpenAPI](https://github.com/hyperledger/web3j-openapi) generator,
you need to have the [Web3j-CLI](https://docs.web3j.io/latest/command_line_tools/) installed on your machine.
It’s easy to do (for Windows instructions head [here](https://github.com/hyperledger/web3j-cli/)):
```ssh
$ curl -L get.web3j.io | sh
```
### Create a Hello World project
To create a base OpenAPI project using a `Hello World` contract, run the following :
```ssh
$ web3j openapi new
```
You can also generate a `Web3j-OpenAPI` project using the [Web3j-OpenAPI-gradle-plugin](https://github.com/web3j/web3j-openapi-gradle-plugin).
### Configure the project
After having the generated project, you can configure your application with the following environment variables:
```ssh
$ export WEB3J_ENDPOINT=
$ export WEB3J_PRIVATE_KEY=
$ export WEB3J_OPENAPI_HOST=localhost
$ export WEB3J_OPENAPI_PORT=9090
```
### Run the project
If you aren't using the Web3j-CLI you may run the project using the following Gradle target:
```ssh
$ cd
$ ./gradlew run
```
Then, you should be seeing the server logs.
### Interact with the project
#### SwaggerUI
The easiest way to interact with the generated project is via the generated `Swagger-UI` which can be found on `http://:/swagger-ui`.
#### Web3j-OpenAPI client
Also, you can use our client implementation via adding the following dependency to your project:
```groovy
dependencies {
implementation "org.web3j.openapi:web3j-openapi-client:4.14.0"
}
```
Then, within the application:
```kotlin
val service = ClientService("http://localhost:9090")
val app = ClientFactory.create(::class.java, service)
// Then you have access to all the API resources
val receipt = app.contracts.contractName.deploy()
println("Deployment receipt: ${receipt.contractAddress}")
// ...
```
#### **For more information**, please refer to the [documentation](https://docs.web3j.io/web3j_openapi).