Skip to content

typeworld/sampleFlaskServer

main
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 

Dummy Flask Server for the Type.World JSON Protocol

In app.py you’ll find a sample implementation for an API Endpoint that serves JSON data under the Type.World JSON Protocol (see: https://github.com/typeworld/typeworld/tree/master/Lib/typeworld/api).

You can use this as a starting point for your own implementation.

This server in NOT FUNCTIONAL and needs to be connected to your own environment, databases etc. It provides some guidance to your own implementation, but can’t do the magic for you. All variables with double underscores such as __ownDataSource__ indicate that these need to be set up by you, containing your data. You may freely rename these methods and variables to match your data setup.

This sample server uses the typeworld.api module (of https://github.com/typeworld/typeworld) for creating the object structure, which can then be easily put out as JSON code with root.dumpJSON().

Sadly, this module exists only for Python. If you want to implement your API Endpoint in another server-side programming language, you need to assemble the JSON data structure manually. You’ll find guidance for each object’s JSON code over at https://github.com/typeworld/typeworld/tree/master/Lib/typeworld/api

All variables with double underscores such as __ownDataSource__ indicate that these need to be set up by you, containing your data. You may freely renamed these methods an variables to match your data setup.

About

Dummy Flask Server of the Type.World JSON Protocol

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages