Data

Tools

Indexes

Applications

Experiments

Open Source Science

swagger-starter

Swagger Starter Kit for sharing API specifications

https://github.com/sixarm/swagger-starter

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (9.9%) to scientific vocabulary
Last synced: 8 months ago · JSON representation ·

Repository

Swagger Starter Kit for sharing API specifications

Basic Info
  • Host: GitHub
  • Owner: SixArm
  • Language: JavaScript
  • Default Branch: master
  • Size: 177 KB
Statistics
  • Stars: 2
  • Watchers: 4
  • Forks: 1
  • Open Issues: 0
  • Releases: 0
Created about 11 years ago · Last pushed about 1 year ago
Metadata Files
Readme Code of conduct Citation

README.md

Swagger Starter Kit

Swagger Starter Kit is a simple way to share a Swagger API specification file.

This project is based on the Swagger UI project.

To get started, look in the examples directory and see the swagger.yaml file.

For more about Swagger, see the Swagger API page.

Create a Swagger file

Create a Swagger file any way you like:

  • You can name the file anything you want. Convention is swagger.yaml or swagger.json.

  • You can create the file by using any editor to write YAML or JSON.

  • If you want more power, try the Swagger Code Generator.

If your file uses YAML, then translate it to JSON:

Host the file anywhere on the web:

  • We typically put the file at the top of a site, such as http://example.com/swagger.json.

  • Browse to the URL. This verifies the file is readable by your web browser.

  • Browse to http://petstore.swagger.io/ and enter the file's URL. This validates the file.

Create a Swagger server

Edit the files in this directory as you like:

  • Edit index.html to see how to add your file's URL as the default URL.

  • Customize index.html if your API uses an API key, or authentication token, etc.

  • Customize anything else you want, such as HTML, CSS, JS.

Copy everything here to any directory on any webserver:

  • We typically put this at the top level of a site, such as http://example.com/swagger/.

  • This directory can be anywhere; it doesn't need to be with your swagger.json file.

  • Browse to the URL. This loads the Swagger code and your Swagger file.

How this repo relates to Swagger UI

This repository is based on the Swagger UI dist directory.

We make some adjustments, such as:

  • Edit index.html to make it easier for novices, and to remove the "Pet Store" demo.

  • Delete unneeded directories and files, such as fonts and typography.css.

  • Move the swagger-*.js files to the lib directory.

Work In Progress

Get feedback and suggestions from the Swagger community.

Continue cleaning out "Pet Store" items.

To Do

Automate the tracking of Swagger UI:

  • When Swagger UI dist is updated, we want this repo updated too.

Consider suggesting this starter kit as a top level Swagger project.

  • If people are interested in this, please let us know, and we'll proceed.

Owner

  • Name: SixArm
  • Login: SixArm
  • Kind: organization
  • Email: sixarm@sixarm.com
  • Location: San Francisco

SixArm Software

Citation (CITATION.cff) 

cff-version: 1.2.0
title: Swagger Starter Kit
message: >-
  If you use this work and you want to cite it,
  then you can use the metadata from this file.
type: software
authors:
  - given-names: Joel Parker
    family-names: Henderson
    email: joel@joelparkerhenderson.com
    affiliation: joelparkerhenderson.com
    orcid: 'https://orcid.org/0009-0000-4681-282X'
identifiers:
  - type: url
    value: 'https://github.com/SixArm/swagger-starter/'
    description: Swagger Starter Kit
repository-code: 'https://github.com/SixArm/swagger-starter/'
abstract: >-
  Swagger Starter Kit
license: See license file

GitHub Events

Total
  • Push event: 1
Last Year
  • Push event: 1

Committers

Last synced: about 1 year ago

All Time
  • Total Commits: 8
  • Total Committers: 1
  • Avg Commits per committer: 8.0
  • Development Distribution Score (DDS): 0.0
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Joel Parker Henderson j****l@j****m 8
Committer Domains (Top 20 + Academic)
joelparkerhenderson.com: 1

Issues and Pull Requests

Last synced: about 1 year ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels