Skip to content

Source code repository of the Rokwire App Config, Authentication, Events, Profile, and Logging Building Blocks, and Authentication Middleware Library.

License

Notifications You must be signed in to change notification settings

rokwire/rokwire-building-blocks-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

22c3c50 · Jun 11, 2020
May 16, 2019
Jun 11, 2020
Aug 14, 2019
Jun 11, 2020
Jul 29, 2019
Jun 11, 2020
Jun 11, 2020
Jun 11, 2020
Jun 11, 2020
May 3, 2020
Jan 21, 2020
Jun 11, 2020
Aug 26, 2019
Aug 26, 2019
Sep 17, 2019
Sep 25, 2019
Sep 20, 2019
Sep 20, 2019
Sep 20, 2019
Sep 20, 2019
Sep 20, 2019
Sep 20, 2019
Jun 11, 2020

Repository files navigation

Rokwire Building Blocks API

API definitions of the Rokwire Platform building blocks

How to view API design doc

There are several ways to view API design and document using Swagger:

  • Go to Swagger UI demo page and paste Rokwire API YAML file URL there.

  • Sign up a free account at SwaggerHub and create new API by importing your copy of rokwire.yaml file.

  • Get swagger docker image, for example

    docker pull swaggerapi/swagger-ui 
    

    Run docker image locally by executing command like

    docker run -p 80:8080 -e SWAGGER_JSON=/foo/rokwire.yaml -v /rokwire_yaml_local_dir/:/foo -e BASE_URL=/docs swaggerapi/swagger-ui 
    

    Then access the API doc at http://localhost/docs.

  • Create Rokwire Platform API Docker image using instructions in section Docker / AWS ECR and run:

    docker run -p 80:8080 rokwire/api-doc 
    

    Then access the API doc at http://localhost/docs.

Docker / AWS ECR

Create Docker image for Rokwire Platform API and push to AWS ECR for deployment using Fargate from within AWS CLI:

docker build -t rokwire/api-doc .
docker tag rokwire/api-doc:latest 779619664536.dkr.ecr.us-east-2.amazonaws.com/rokwire/api-doc:latest
docker push 779619664536.dkr.ecr.us-east-2.amazonaws.com/rokwire/api-doc:latest

AWS EC2 Deployment

  • Deploy api doc to AWS instance (created with Ubuntu Server 18.04 LTS image)

    cd /home/ubuntu
    git clone https://github.com/rokwire/rokwire-building-blocks-api.git
    
    

    Start docker container on AWS instance

    Make sure one of the security groups that the instance associated with, includes inbound rule accepting http requests from port 80 and 8080.

    cd /home/ubuntu/rokwire-building-blocks/deployment
    sh start_rokwire_apidoc_container.sh
    
    

    Stop and remove docker container on AWS instance

    cd /home/ubuntu/rokwire-building-blocks/deployment
    sh stop_rokwire_apidoc_container.sh
    
    

About

Source code repository of the Rokwire App Config, Authentication, Events, Profile, and Logging Building Blocks, and Authentication Middleware Library.

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks