mirrors/object-browser
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Development md (#34)

Browse Source 
* Introduce DEVELOPMENT.md

* Ignore *.orig files

Co-authored-by: Lenin Alevski <alevsk.8772@gmail.com>
This commit is contained in:
Daniel Valdivia
2020-04-06 14:22:27 -07:00
committed by GitHub
parent 3a96e6d7e7
commit 69ed6f5ca4
3 changed files with 34 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@@ -1,4 +1,4 @@
# MCS Minio Console Service
# Minio Console Server
A graphical user interface for [MinIO](https://github.com/minio/minio)
@@ -64,32 +64,4 @@ You can verify that the apis work by doing the request on `localhost:9090/api/v1
# Development
This is a REST portal server created using [go-swagger](https://github.com/go-swagger/go-swagger)
The API handlers are created using a YAML definition located in `swagger.YAML`.
To add new api, the YAML file needs to be updated with all the desired apis using the [Swagger Basic Structure](https://swagger.io/docs/specification/2-0/basic-structure/), this includes paths, parameters, definitions, tags, etc.
## Generate server from YAML
Once the YAML file is ready we can autogenerate the code needed for the new api by just running:
Validate it:
```
swagger validate ./swagger.yml
```
Update server code:
```
make swagger-gen
```
This will update all the necessary code.
`./restapi/configure_mcs.go` is a file that contains the handlers to be used by the application, here is the only place where we need to update our code to support the new apis. This file is not affected when running the swagger generator and it is safe to edit.
## Unit Tests
`./restapi/handlers_test.go` needs to be updated with the proper tests for the new api.
To run tests:
```
go test ./restapi
```
For development on this project please refer to our [DEVELOPMENT.md](DEVELOPMENT.md)