Comments (5)
Ideally, we would have some form of contract tests. I will gather a few resources around that.
from comit-rs.
My vision would be that at some point our APIs are documented using JSON hyperschema (https://blog.apisyouwonthate.com/getting-started-with-json-hyper-schema-184775b91f).
That is a specification that allows to describe (proper) REST APIs (with hypermedia and stuff).
I think for now, we are also fine with using OpenAPI (version 3). OpenAPI takes a more procedural approach that defines all the paths instead of relying on links. There is quite an ecosystem around OpenAPI.
Here is what I imagine:
- API description file in the root of each service (contracts)
- A tool to generate stubs from these contracts (so that we don't have to write the fake services ourselves)
- A tool that generates human-readable documentation from these contracts
from comit-rs.
"open source" added to force discussion
from comit-rs.
IMHO: Not needed for opensource.
from comit-rs.
To do once people start asking about how they can write their own application.
from comit-rs.
Related Issues (20)
- Orderbook should support bidirectional trading
- Unclear whether the orders are correctly converted to swaps
- Add partial order support to take order protocol HOT 1
- offline takers will probably miss out on trading pair announcements
- Model Ethereum's "data" and "quantity" types including hex serialization HOT 1
- Find a way to run Rust tests on MacOS and Windows HOT 6
- Removing `LocalSwapId` from the comit library
- Run e2e tests on windows HOT 1
- try_lock_exclusive() on data dir, causes stable Access denied (os error 5) on Windows 10 HOT 5
- RUSTSEC-2020-0036: failure is officially deprecated/unmaintained HOT 2
- RUSTSEC-2018-0017: `tempdir` crate has been deprecated; use `tempfile` instead HOT 1
- Lazily build cnd/nectar as part of the e2e test suite HOT 1
- RUSTSEC-2020-0054: directories is unmaintained, use directoriess-next instead
- RUSTSEC-2020-0054: directories is unmaintained, use directoriess-next instead
- RUSTSEC-2020-0041: Multiple soundness issues in Chunk and InlineArray HOT 4
- RUSTSEC-2020-0057: crate has been renamed to `cipher` HOT 1
- RUSTSEC-2020-0056: stdweb is unmaintained HOT 1
- RUSTSEC-2020-0058: crate has been renamed to `cipher` HOT 1
- We really need to do this todo HOT 4
- RUSTSEC-2020-0146: arr! macro erases lifetimes
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from comit-rs.