Ajouter manteau magnifique, j'ai développé une API

Dans le développement quotidien, est le plus susceptible d'être un code écrit Tucao mauvais, vous savez que ce n'est pas un commentaire fantômes Qu'est-ce que ah moyenne?

Un autre document est incomplet, ces interfaces le font? Paramètres Qu'est-ce que cela signifie? Et ainsi de suite.

Dans l'analyse finale, il n'y a pas de normes strictes de développement, la chose la plus importante est d'avoir un outil pratique pour nous aider à l'atterrissage de ces spécifications.

Aujourd'hui, nous vous recommandons un outil de gestion de l'API open source, si vous ne passez pas le sentiment de le voir.

STRUCTURE

YAPI est efficace, facile à utiliser, puissante plate-forme de gestion de api conçu pour le développement de produits, les testeurs fournir un service de gestion d'interface plus élégante. Peut aider les développeurs à créer facilement, publier, maintenir l'API, YAPI fournit également aux utilisateurs une excellente expérience interactive, les développeurs peuvent simplement utiliser la plate-forme de données d'interface fournit des outils et d'écrire un seul clic, vous pouvez gérer l'interface.

Accueil: yapi.demo.qunar.com/

GitHub: github.com/YMFE/yapi

propriété

• Basée sur la structure de données de retour Json5 et Mockjs définit l'efficacité de l'interface et la documentation fois
• les droits de conception plats, ce qui est d'assurer la gestion des projets d'entreprise à grande échelle, mais aussi pour assurer la facilité d'utilisation
• Interface de débogage postman similaire
• Les tests automatisés, le soutien à la réponse de l'affirmation
• En plus de soutenir la maquette de MockServer aléatoire commun, mais aussi une augmentation de la fonction Mock souhaité, selon les règles de filtrage définis par la demande, renvoyer les données attendues
• postier de soutien, har, l'importation de données fanfaronnades
• Libre et open source, le déploiement de réseau, n'a plus peur de fuite d'informations

Page d'accueil

API Informations de base

Paramètres et réponses

fanfaron

introduction

Swagger est un cadre normalisé et complet pour la génération, la description et les appels de visualisation pour les services Web RESTful. L'objectif de Swagger est de définir une API standard REST et une interface indépendante de la langue, et les informaticiens ont pas besoin d'accéder au code source, des documents ou des capacités de surveillance du trafic réseau et la compréhension des services peuvent être trouvés. Lorsqu'il est correctement défini par Swagger, l'utilisateur peut comprendre et utiliser le service à distance et de la logique d'interaction minimale de mise en œuvre de services à distance. Et pour les interfaces de programmation sous-jacentes mises en œuvre similaire, Swagger peut avoir éliminé le service d'appel devinettes.

GitHub: github.com/swagger-api

intégré

Spring Boot peut être utilisé dans le package open source pour démarreur intégré sera plus simple, comme nous utilisons le paquet de spring4all, la dépendance Maven comme suit:

<dependency>
    <groupId>com.spring4all</groupId>
    <artifactId>swagger-spring-boot-starter</artifactId>
    <version>1.9.1.RELEASE</version>
</dependency>
复制代码

repose Après plus un bon plus @ EnableSwagger2Doc pour permettre Swagger la classe de démarrage.

utilisation

Ensuite, ne pas expliquer l'utilisation spécifique, et est relativement simple, il est d'ajouter quelques notes sur votre interface pour décrire cette interface est fait.

La valeur par défaut sans commentaire votre interface peut également apparaître toutes une méthode de balayage qui est dans votre @RestController.

Page d'accueil

Interface Liste

Il y a un problème que vous pourriez rencontrer

En règle générale, nous allons procéder à une gestion globale d'exception dans le projet, lorsqu'une erreur se produit, une exception sera capturé puis converti en un format fixe de la réponse à l'appelant. Ce format de données unifiée de l'API.

Nous allons configurer les paramètres suivants, dites SpringBoot ne pas créer un fichier de ressources cartographie notre projet, de sorte que vous pouvez retrouver le contenu de JSON pur.

spring.resources.add-mappings=false
复制代码

Mais notre fanfaronnades-ui.html ne peut pas accéder, si les ressources doivent cartes connexes swagger-ui.html seul.

@Configuration
public class WebAppConfigurer extends WebMvcConfigurationSupport {
    @Override
    protected void addResourceHandlers(ResourceHandlerRegistry registry) {
       
        registry.addResourceHandler("/swagger-ui.html")
                .addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**")
                .addResourceLocations("classpath:/META-INF/resources/webjars/");
        super.addResourceHandlers(registry);
        
    }
    
}
复制代码

ShowDoc

ShowDoc documentation de l'API en ligne est une équipe très appropriée, des outils de documentation technique.

Accueil: www.showdoc.cc/

GitHub: github.com/star7th/sho...

Nous pouvons faire la documentation API ShowDoc, dictionnaire de données, pour les documents des fins d'illustration. Il peut être déployé leur propre, personnelle, vous pouvez également utiliser les spectacles officiels en ligne répertoriés.

ShowDoc soutien à la gestion des droits, le soutien à l'édition démarquage, le soutien à l'exportation, le soutien au partage et à d'autres fonctions.

documentation de l'API

Dictionnaire de données

CRAP-API

CRAP-API est totalement open source, libre de l'API du système de gestion de la collaboration. Fournir le développement collaboratif, test en ligne, gestion de documents, interface d'exportation, les fonctions de personnalisation, telles que des fonctionnalités personnalisées.

Accueil: api.crap.cn/

GitHub: github.com/EhsanTang/A...

propriété

• BOGUE simple et système de gestion efficace pour enregistrer tous les changements
• Travail d'équipe, contrôle d'accès, journal des modifications
• tables de base de données, démarquage, reposant, maquette, pdf, word
• Chrome plug-ins open source, le support pour le contre-domaine, les interfaces locales, débogage en ligne
• Le système est entièrement gratuit, entièrement open source

API de gestion

nouvelle API

Dictionnaire de données

Les données du dictionnaire prend également en charge la génération de fichier XML mybatis pour générer les objets Java entité.

Intéressés peuvent suivre mon numéro public micro lettre du monde des singes , la première fois à lire des articles plus techniques. J'ai aussi un code open source GitHub github.com/yinjihuan