https://github.com/lornajane/openapi-blockly-representation

Demo repo uses blockly to visualise structure of OpenAPI
https://github.com/lornajane/openapi-blockly-representation

blockly datavisualization openapi3

Last synced: 5 months ago
JSON representation

Demo repo uses blockly to visualise structure of OpenAPI

• Host: GitHub
• URL: https://github.com/lornajane/openapi-blockly-representation
• Owner: lornajane
• License: apache-2.0
• Created: 2023-05-07T12:05:23.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-06-10T19:00:56.000Z (over 2 years ago)
• Last Synced: 2024-10-11T23:12:37.888Z (12 months ago)
• Topics: blockly, datavisualization, openapi3
• Language: HTML
• Homepage:
• Size: 461 KB
• Stars: 11
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Blockly representation of OpenAPI

This doesn't compile to OpenAPI (pull requests welcome), but I use these blocks as a teaching aid. You're welcome to use them too.

![A single endpoint represented by blocks](./images/openapi-schema-ref-blocks.png)

## Get started

Run `npm install`.

Then serve `index.html` locally. It's useful to have it reload, so I use this:

```

npx browser-sync start --server --files index.html

```

### Example blocks

Try `example.json`.

### Technical notes

The "save" functionality uses local storage so you can engineer the blocks without losing what you built on reload.

## Used by

Send a pull request if you use this project? Let's share!

- Lorna ( [me](https://github.com/lornajane/) ) in my talk [OpenAPI for Documentarians](https://noti.st/lornajane/4Ojem2/openapi-for-documentarians)