Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/amrhossamdev/topology-api
Topology API is an API to provide the functionality to access, manage and store device topologies.
https://github.com/amrhossamdev/topology-api
api kotlin maven oop unit-testing
Last synced: 24 days ago
JSON representation
Topology API is an API to provide the functionality to access, manage and store device topologies.
- Host: GitHub
- URL: https://github.com/amrhossamdev/topology-api
- Owner: amrhossamdev
- Created: 2022-05-17T01:58:01.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2022-05-20T03:24:47.000Z (over 2 years ago)
- Last Synced: 2024-01-22T18:10:10.639Z (10 months ago)
- Topics: api, kotlin, maven, oop, unit-testing
- Language: Kotlin
- Homepage:
- Size: 222 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Topology-API
Topology API is an API to provide the functionality to access, manage and store device topologies.
# Langugage
Used `Kotlin` : Kotlin is a modern, statically-typed programming language that features both object-oriented and functional programming constructs
# Functionalities
1. Read a topology from a given JSON file and store it in the memory.
2. Write a given topology from the memory to a JSON file.
3. Query about which topologies are currently in the memory.
4. Delete a given topology from memory.
5. Query about which devices are in a given topology.
6. Query about which devices are connected to a given netlist node in a given topology
# Technologies
- Kotlin
- Intelj IDE
- Maven
- Junit for unit testing
- Json simple to parse json files to json objects
# Design
Design is done using object orinted programming all tests passed and achived
- `Topology` class represent topology in the memory
- `Device` is the parentclass and resistor & nmos child classes
- `nmos` and `resistor` classes holds write and convert json functions
- `Device specs` present devices specs
# Run project
First, clone the repo:
`git clone [email protected]:amrhossamdev/Topology-Api.git`
# Run project in intellj
open -> and import the project then select maven
# Testing
Done using junit testing
You can test all functionalities in `test folders` -> then open `TopologyApiTest`
# Testing passed
