search

artavd / device-emulator

Application for emulation of message-based devices
0 stars 0 forks source link

Design of REST API for emulator service #8

Closed artavd closed 7 years ago

artavd commented 8 years ago

Analyze different ways to interact between many end-point server application and admin web appication. Requirements:

  1. Admin web application is not only UI client to server app. It can be Emulator Shell also or .NET Device Emulator GUI.
  2. Approach should not be Spring- or JVM- specific because it also will be .NET client and possible other ones (as samples to investigate any technologies).
artavd commented 8 years ago

Suggested approach:

  1. Emulator Console application has options "-s, --server ". If this options specified then it starts in server mode and start listening specified port and provide REST API on this port.
  2. Emulator Web console provides ability for user to specify any end point (host:port) where some instance of described above REST API is started. After that user can interact with specifed end-point via this API.
  3. REST API include ability to acquire specific end-point by user to other users will not be able to interact with it.
  4. Not only Web console can use this REST API but other utilities too - Emulator Shell, .NET WPF Device Emulator and may be other, that will be developed as POC for some technolgies in future.
artavd commented 8 years ago

REST API should be documented. Initial drafts will be in comments here.

artavd commented 7 years ago

REST API implemented. Tasks for documentation and other not implemented things described above raised.