Skip to content

Add a simple OpenAPI spec #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ennc0d3 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add a simple OpenAPI spec #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions internal/api/handler.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,10 @@ func handleVideoInfo(w http.ResponseWriter, r *http.Request) {
_, span := tracer.Start(r.Context(), "handleVideoInfo")
defer span.End()

videoID := r.URL.Query().Get("video_id")
videoID := r.URL.Query().Get("videoid")
if videoID == "" {
hlog.FromRequest(r).Error().Msg("video_id parameter is missing")
http.Error(w, "video_id parameter is missing", http.StatusBadRequest)
hlog.FromRequest(r).Error().Msg("videoid parameter is missing")
http.Error(w, "videoid parameter is missing", http.StatusBadRequest)
return
}

Expand Down
23 changes: 23 additions & 0 deletions spec/ytstat-openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
penapi: 3.0.0
info:
title: Youtube Statistics API
description: Optional multiline or single-line description in [CommonMark](http://commonmark.org/help/) or HTML.
version: 0.1.9
servers:
- url: http://api.example.com/v1
description: Optional server description, e.g. Main (production) server
- url: http://staging-api.example.com
description: Optional server description, e.g. Internal staging server for testing
paths:
/videoid:
get:
summary: Returns stats for the give video id.
description: Optional extended description in CommonMark or HTML.
responses:
'200': # status code
description: JSON document with stats for the video
content:
application/json:
schema:
type: object