Facilitates defining typesafe data transfer models and endpoints for services, compiling them into language-specific bindings, and converting from OpenAPI specifications. Offers CLI and IDE extensions.
Wirespec is a modern tool that enhances software development by streamlining the process of designing, documenting, and implementing APIs. While the software industry offers numerous solutions for designing contracts between services, Wirespec distinguishes itself by using a simple language model and multi-language compatibility.
Here are some key reasons why you might want to use Wirespec:
In summary, using Wirespec during software development leads to faster, more reliable, and collaborative API creation while reducing errors and improving overall project efficiency.
You can explore and experiment with Wirespec by using the Wirespec playground. Whether you are new to Wirespec or a seasoned user, the playground makes is simple to design, test and improve your API specifications- all in one place.
Wirespec files can be compiled into language specific binding by using the cli
wirespec compile ./todo.ws -o ./tmp -l Kotlin
Wirespec offers integration libraries with differ libraries.
curl -L https://github.com/flock-community/wirespec/releases/latest/download/linuxX64.kexe -o wirespec
chmod +x wirespec
sudo mv ./wirespec /usr/local/bin/wirespec
curl -L https://github.com/flock-community/wirespec/releases/latest/download/macosX64.kexe -o wirespec
chmod +x wirespec
sudo mv ./wirespec /usr/local/bin/wirespec
curl -L https://github.com/flock-community/wirespec/releases/latest/download/macosArm64.kexe -o wirespec
chmod +x wirespec
sudo mv ./wirespec /usr/local/bin/wirespec
wirespec -h
Usage: wirespec options_list
Subcommands:
compile - Compile Wirespec
convert - Convert from OpenAPI
Arguments:
input -> Input file { String }
Options:
--output, -o -> Output directory { String }
--debug, -d [false] -> Debug mode
--languages, -l -> Language type { Value should be one of [Java, Kotlin, TypeScript, Python, Wirespec] }
--packageName, -p [community.flock.wirespec.generated] -> Package name { String }
--strict, -s [] Strict mode
--help, -h Usage info
wirespec convert -h
Usage: wirespec convert options_list
Arguments:
input -> Input file { String }
format -> Input format { Value should be one of [openapiv2, openapiv3] }
Other examples can be found here
Clone this repository and run (n *nix systems):
make all
to compile the project and test the Wirespec compiler with definitions found in types. Locate the result
in types/out
Each emitter (java, kotlin, python, rust, scala, typescript) keeps its expected outputs as .txt files under . Tests compare the emitter's output against these files. When you change emitter behavior on purpose, regenerate the fixtures for that module:
./gradlew :src:compiler:emitters:kotlin:updateEmitterFixtures
Substitute kotlin with the language you changed. The task runs the emitter against the shared test inputs and overwrites the .txt files — always review the diff before committing.
A release can be made using GitHub the UI. Go to https://github.com/flock-community/wirespec/releases/new
v*.*.*Release *.*.*Publish releaseSimplified API Design through Human-Readable contracts
Reduced Development Time
Future-Proof Development
src/compiler/emitters/<lang>/fixtures/Surfaced from shared tags and platforms — no rankings paid for.