Skip to content

Commit

Permalink
Updated README.md (#33)
Browse files Browse the repository at this point in the history
  • Loading branch information
dvaldivia committed Apr 6, 2020
1 parent c8938dc commit 9a2b104
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
@@ -1,6 +1,6 @@
# MCS Minio Console Service

This is a REST portal server created using [go-swagger](https://github.com/go-swagger/go-swagger)
A graphical user interface for [MinIO](https://github.com/minio/minio)

## Setup

Expand Down Expand Up @@ -57,13 +57,15 @@ To run the server:
export MCS_ACCESS_KEY=mcs
export MCS_SECRET_KEY=YOURMCSSECRET
export MCS_MINIO_SERVER=http://localhost:9000
./mcs
./mcs server
```

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.
Expand Down

0 comments on commit 9a2b104

Please sign in to comment.