Adding static API docs to my tiny API

Improving the developer experience

jobs:
deploy:
name: Deploy
runs-on: ubuntu-latest
steps:
- name: Checkout Repo
uses: actions/checkout@master
- name: Generate Swagger UI
uses: Legion2/swagger-ui-action@v1
with:
output: swagger-ui
spec-file: nz-recycling-advanced-prod-oas30-apigateway.json
- name: Deploy to S3
uses: jakejarvis/s3-sync-action@master
with:
args: --acl public-read --delete
env:
AWS_S3_BUCKET: www.cronin.nz
DEST_DIR: apps/recycling-api-docs
SOURCE_DIR: swagger-ui
AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
AWS_REGION: us-west-2
- name: Invalidate Cloudfront cache
uses: muratiger/invalidate-cloudfront-and-wait-for-completion-action@master
env:
DISTRIBUTION_ID: ${{ secrets.AWS_DISTRO }}
PATHS: '/*'
AWS_REGION: us-west-2
AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
The published site

--

--

--

Technology leader for Xero in Auckland, New Zealand, former start-up founder, father of two, maker of t-shirts and small software products

Love podcasts or audiobooks? Learn on the go with our new app.

Recommended from Medium

How To Fix Micromax Bolt Q324 Not Charging [Troubleshooting Guide]

How To Fix Micromax Canvas Mega 2 Q426 Not Charging [Troubleshooting Guide]

EPISODE #34: What Large Enterprises can Learn From Automation in SMB’s

A dockerized pub-sub message queue implementation in Django by using RabbitMQ and Celery

Software Project Estimation And Biases

How seeing ghosts can help you model real-world software testing scenarios

Sorting Algorithms and Big-O Analysis

Coding Exercises != good interviews

Get the Medium app

A button that says 'Download on the App Store', and if clicked it will lead you to the iOS App store
A button that says 'Get it on, Google Play', and if clicked it will lead you to the Google Play store
Gareth Cronin

Gareth Cronin

Technology leader for Xero in Auckland, New Zealand, former start-up founder, father of two, maker of t-shirts and small software products

More from Medium

API Specification Design With Spectral and Prism

How we migrated from RDS MySql to RDS Aurora and stopped suffering from lags

Progressive Delivery Strategies For Efficient, Risk Mitigated Deployment

Homeland Security guide for Solution Architecture. [Part-2]