Code Monkey home page Code Monkey logo

azurefunction-swaggerdefinition's Introduction

AzureFunction Swagger Definition Generator

Author Twitter
Mikael Svenson @mikaelsvenson

Azure function to generate a proper Swagger definition for the other Azure functions in your project.

Maybe a bit meta ;)

Notes and reflection on my part

  • The Swagger generator will only create 200 return codes. If you have other return codes you need to specify them manually.
    • As an example, you might want to return 201 (Created) if your operation creates something.
  • It's recommended to use objects as both input and output parameters, as they are most descriptive
  • It's recommended to use POST over GET for complex input, as chanses of encoding issues etc. are smaller.
  • See Templates.cs for common useful Function signatures.
  • I don't fine the default in parameter HttpRequestMessage all that useful, as generating Swagger from random input is quite hard. Better to pass in a typed request object.

azurefunction-swaggerdefinition's People

Contributors

joeljeffery avatar pschaeflein avatar rwatjen avatar wobba avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

azurefunction-swaggerdefinition's Issues

Nuget Package

Hi,
would it be possible to make a Nuget Package out of this Project? Really cool idea btw.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.