https://github.com/tpluscode/restalk-editor
https://github.com/tpluscode/restalk-editor
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/tpluscode/restalk-editor
- Owner: tpluscode
- Created: 2016-09-17T17:56:07.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2016-12-07T12:04:53.000Z (over 8 years ago)
- Last Synced: 2025-02-10T21:45:42.649Z (5 months ago)
- Size: 1000 Bytes
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# restalk-editor
This repository will hopefully evolve to become a tool for creating RESTalk Conversation diagrams.
## RESTalk DSL
RESTalk is a (currently) visual language for designing HTTP API interaction, which span over multiple requests to the server.
It defines multiple building blocks, which you can see in the image below.
To learn more, follow the links below:
* [RESTalk patterns](http://restalk-patterns.org/)
* [RESTFest Edinburgh 2016 slides](https://github.com/RESTFest/2016-Edinburgh/wiki/Cesare-Pautasso#proposed-talks)
## The problem
RESTalk was designed as a teaching tool - the main purpose is to document the repeating patterns, commonly seen in Client-Server
interaction. There is, however, great potential for it to become a API design tool.
To become a design tools it would be necessary to create
1. a human-readable, preferably textual, format (JSON? YAML? Markdown?) for authoring the conversations
2. simple tooling for generating RESTalk diagrams
3. (optional) more sophisticated tooling for creating conversations visually
## The solution
1. [Design the language][issue-design]
2. [Implement diagram generation][issue-generation]
3. [Implement visual editor][issue-editor]
[issue-design]: https://github.com/tpluscode/restalk-editor/issues/1
[issue-generation]: https://github.com/tpluscode/restalk-editor/issues/2
[issue-editor]: https://github.com/tpluscode/restalk-editor/issues/3